fea: add mqtt over websocket; modify remote ssh; modify wslay event frame buf 4096 --> 512

Author: tedazhao

CMakeLists.txt

@@ -55,6 +55,10 @@ set(FEATURE_AUTH_MODE "KEY")
 # Whether access authentication uses TLS, certificate authentication must use TLS, key authentication can choose not to use TLS
 set(FEATURE_AUTH_WITH_NOTLS ON)
 
+# 是否打开 WEBSOCKET MQTT 功能
+# Whether to turn on Master Switch for the websocket-mqtt
+set(FEATURE_WEBSOCKET_MQTT OFF)
+
 # 是否打开多线程功能支持
 # Whether to turn on multi-threading support
 set(FEATURE_MULTITHREAD_ENABLED ON)
@@ -123,9 +127,10 @@ set(FEATURE_RESOURCE_SIGNAL_CHANNEL "MQTT")
 # Whether to use HTTPS for resource manage
 set(FEATURE_RESOURCE_USE_HTTPS ON)
 
-# 是否打开远程登录 SSH 功能
+# 是否打开远程登录 WEBSOCKET SSH 功能
 # Whether to turn on Master Switch for the remote login ssh
-set(FEATURE_REMOTE_LOGIN_SSH ON)
+set(FEATURE_REMOTE_LOGIN_WEBSOCKET_SSH OFF)
+
 ######################CONFIG END######################################
 
 # 设置CMAKE使用编译工具及编译选项
@@ -198,7 +203,8 @@ option(AT_TCP_ENABLED "Enable AT_TCP" ${FEATURE_AT_TCP_ENABLED})
 option(BROADCAST_ENABLED "Enable BROADCAST" ${FEATURE_BROADCAST_ENABLED})
 option(RRPC_ENABLED "Enable RRPC" ${FEATURE_RRPC_ENABLED})
 option(REMOTE_CONFIG_MQTT "Enable REMOTE_CONFIG_MQTT" ${FEATURE_REMOTE_CONFIG_MQTT_ENABLED})
-option(REMOTE_LOGIN_SSH "Enable REMOTE_LOGIN_SSH" ${FEATURE_REMOTE_LOGIN_SSH})
+option(REMOTE_LOGIN_WEBSOCKET_SSH "Enable REMOTE_LOGIN_WEBSOCKET_SSH" ${FEATURE_REMOTE_LOGIN_WEBSOCKET_SSH})
+option(WEBSOCKET_MQTT "Enable WEBSOCKET_MQTT" ${FEATURE_WEBSOCKET_MQTT})
 
 if (${FEATURE_AUTH_WITH_NOTLS} STREQUAL "OFF")
 if (${FEATURE_OTA_USE_HTTPS} STREQUAL "ON")
@@ -220,6 +226,12 @@ else()
 	option(AT_DEBUG "Enable AT_DEBUG" OFF)
 endif()
 
+if(${FEATURE_WEBSOCKET_MQTT} STREQUAL "ON" OR ${FEATURE_REMOTE_LOGIN_WEBSOCKET_SSH} STREQUAL "ON")
+	option(WEBSOCKET_CLIENT "Enable WEBSOCKET_CLIENT" "ON")
+else()
+	option(WEBSOCKET_CLIENT "Enable WEBSOCKET_CLIENT" "OFF")
+endif()
+
 configure_file (
   "${PROJECT_SOURCE_DIR}/tools/cmake_scripts/config.h.in"
   "${PROJECT_SOURCE_DIR}/include/config.h" 
@@ -265,7 +277,7 @@ if(NOT DEFINED SAMPLE_ONLY)
 	add_subdirectory(${PROJECT_SOURCE_DIR}/sdk_src)
 	add_subdirectory(${PROJECT_SOURCE_DIR}/platform)
 	add_subdirectory(${PROJECT_SOURCE_DIR}/external_libs/mbedtls)
-	if(${FEATURE_REMOTE_LOGIN_SSH} STREQUAL "ON")
+	if(${WEBSOCKET_CLIENT} STREQUAL "ON")
 		add_subdirectory(${PROJECT_SOURCE_DIR}/external_libs/wslay)
 	endif()
 endif()

external_libs/wslay/lib/wslay_event.h

@@ -126,7 +126,7 @@ struct wslay_event_context {
     /* The sum of message length in send_queue */
     size_t queued_msg_length;
     /* Buffer used for fragmented messages */
-    uint8_t  obuf[4096];
+    uint8_t  obuf[512];
     uint8_t *obuflimit;
     uint8_t *obufmark;
     /* payload length of frame currently being sent. */

external_libs/wslay/lib/wslay_frame.h

@@ -49,7 +49,7 @@ struct wslay_frame_opcode_memo {
 };
 
 struct wslay_frame_context {
-    uint8_t                        ibuf[4096];
+    uint8_t                        ibuf[512];
     uint8_t *                      ibufmark;
     uint8_t *                      ibuflimit;
     struct wslay_frame_opcode_memo iom;

platform/tls/mbedtls/HAL_TLS_mbedtls.c

@@ -31,6 +31,7 @@ extern "C" {
 #include "mbedtls/net_sockets.h"
 #include "mbedtls/ssl.h"
 #include "mbedtls/sha256.h"
+#include "mbedtls/debug.h"
 
 #include "qcloud_iot_export_error.h"
 #include "qcloud_iot_export_log.h"
@@ -141,6 +142,15 @@ static void _free_mebedtls(TLSDataParams *pParams)
     HAL_Free(pParams);
 }
 
+#if defined(MBEDTLS_DEBUG_C)
+#define DEBUG_LEVEL 0
+static void _ssl_debug(void *ctx, int level, const char *file, int line, const char *str)
+{
+    Log_i("[mbedTLS]:[%s]:[%d]: %s\r\n", STRING_PTR_PRINT_SANITY_CHECK(file), line, STRING_PTR_PRINT_SANITY_CHECK(str));
+}
+
+#endif
+
 /**
  * @brief mbedtls SSL client init
  *
@@ -163,6 +173,10 @@ static int _mbedtls_client_init(TLSDataParams *pDataParams, TLSConnectParams *pC
     mbedtls_x509_crt_init(&(pDataParams->client_cert));
     mbedtls_pk_init(&(pDataParams->private_key));
 
+#if defined(MBEDTLS_DEBUG_C)
+    mbedtls_debug_set_threshold(DEBUG_LEVEL);
+    mbedtls_ssl_conf_dbg(&pDataParams->ssl_conf, _ssl_debug, NULL);
+#endif
     mbedtls_entropy_init(&(pDataParams->entropy));
     // custom parameter is NULL for now
     if ((ret = mbedtls_ctr_drbg_seed(&(pDataParams->ctr_drbg), mbedtls_entropy_func, &(pDataParams->entropy), NULL,

samples/CMakeLists.txt

@@ -19,7 +19,7 @@ set(link_lib
 )
 endif()
 
-if(REMOTE_LOGIN_SSH STREQUAL "ON")
+if(WEBSOCKET_CLIENT STREQUAL "ON")
 	set(link_lib ${link_lib} wslay)
 endif()
 

sdk_src/CMakeLists.txt

@@ -7,7 +7,8 @@ set(src_sdk  ${src_utils})
 if(${FEATURE_MQTT_COMM_ENABLED} STREQUAL "ON")
 	# mqtt
 	file(GLOB src_mqtt ${CMAKE_CURRENT_SOURCE_DIR}/protocol/mqtt/*.c)
-	list(APPEND src_sdk ${src_mqtt})
+	file(GLOB src_websocket ${CMAKE_CURRENT_SOURCE_DIR}/protocol/websocket/*.c)
+	list(APPEND src_sdk ${src_mqtt} ${src_websocket})
 
 	# shadow 
 	if(${FEATURE_MQTT_DEVICE_SHADOW} STREQUAL "ON")

sdk_src/internal_inc/mqtt_client.h

@@ -137,21 +137,28 @@ typedef struct {
 
     uint8_t auto_connect_enable;  // enable auto connection or not
 
-#ifdef AUTH_WITH_NOTLS
+#if defined(AUTH_WITH_NOTLS) || (defined(WEBSOCKET_MQTT) && defined(AUTH_MODE_KEY))
     char *device_secret;      // PSK
     int   device_secret_len;  // length of PSK
+#elif defined(WEBSOCKET_MQTT) && defined(AUTH_MODE_CERT)
+    char *private_key_file_path;  // device private key
 #endif
-
 } MQTTConnectParams;
 
 /**
  * default value of MQTT connect parameters structure
  */
-#ifdef AUTH_WITH_NOTLS
+#if defined(AUTH_WITH_NOTLS) || (defined(WEBSOCKET_MQTT) && defined(AUTH_MODE_KEY))
 #define DEFAULT_MQTTCONNECT_PARAMS                                            \
     {                                                                         \
         NULL, NULL, NULL, {0}, {'M', 'Q', 'T', 'C'}, 0, 4, 240, 1, 1, NULL, 0 \
     }
+#elif defined(WEBSOCKET_MQTT) && defined(AUTH_MODE_CERT)
+#define DEFAULT_MQTTCONNECT_PARAMS                                         \
+    {                                                                      \
+        NULL, NULL, NULL, {0}, {'M', 'Q', 'T', 'C'}, 0, 4, 240, 1, 1, NULL \
+    }
+
 #else
 #define DEFAULT_MQTTCONNECT_PARAMS                                   \
     {                                                                \

sdk_src/internal_inc/network_interface.h

@@ -29,7 +29,13 @@ extern "C" {
  * Type of network interface
  */
 
-typedef enum { NETWORK_TCP = 0, NETWORK_UDP = 1, NETWORK_TLS = 2, NETWORK_DTLS = 3 } NETWORK_TYPE;
+typedef enum {
+    NETWORK_TCP     = 0,
+    NETWORK_UDP     = 1,
+    NETWORK_TLS     = 2,
+    NETWORK_DTLS    = 3,
+    NETWORK_WS_MQTT = 4,
+} NETWORK_TYPE;
 
 /**
  * @brief Define structure for network stack
@@ -121,6 +127,16 @@ int  network_dtls_init(Network *pNetwork);
 #endif
 #endif
 
+#ifdef WEBSOCKET_MQTT
+int  network_websocket_mqtt_read(Network *pNetwork, unsigned char *data, size_t datalen, uint32_t timeout_ms,
+                                 size_t *read_len);
+int  network_websocket_mqtt_write(Network *pNetwork, unsigned char *data, size_t datalen, uint32_t timeout_ms,
+                                  size_t *written_len);
+void network_websocket_mqtt_disconnect(Network *pNetwork);
+int  network_websocket_mqtt_connect(Network *pNetwork);
+int  network_websocket_mqtt_init(Network *pNetwork);
+#endif
+
 #ifdef __cplusplus
 }
 #endif

sdk_src/internal_inc/qcloud_iot_ca.h

@@ -22,19 +22,23 @@ extern "C" {
 
 const char *iot_ca_get(void);
 
-const char *iot_dynreg_https_ca_get();
+const char *iot_dynreg_https_ca_get(void);
 
 const char *iot_https_ca_get(void);
 
 const char *iot_wss_ssh_ca_get(void);
 
+const char *iot_wss_mqtt_ca_get(void);
+
 const char *iot_get_mqtt_domain(const char *region);
 
+int iot_get_mqtt_port(void);
+
 const char *iot_get_coap_domain(const char *region);
 
 const char *iot_get_dyn_reg_domain(const char *region);
 
-const char *iot_get_log_domain(const char *region);
+const char *iot_get_ws_ssh_domain(const char *region);
 
 const char *iot_get_ssh_domain(const char *region);
 

sdk_src/internal_inc/qcloud_iot_common.h

@@ -20,6 +20,8 @@
 #define QCLOUD_IOT_DEVICE_SDK_APPID     "21010406"
 #define QCLOUD_IOT_DEVICE_SDK_APPID_LEN (sizeof(QCLOUD_IOT_DEVICE_SDK_APPID) - 1)
 
+#define QCLOUD_IOT_MQTT_DOMAIN_WITH_PREFIX 1
+
 /* MQTT server domain */
 #define QCLOUD_IOT_MQTT_COAP_DIRECT_DOMAIN     "iotcloud.tencentdevices.com"
 #define QCLOUD_IOT_MQTT_COAP_US_EAST_DOMAIN    "us-east.iotcloud.tencentdevices.com"
@@ -31,6 +33,15 @@
 
 #define COAP_SERVER_PORT 5684
 
+/* WEBSOCKET MQTT server domain */
+#define QCLOUD_IOT_WEBSOCKET_MQTT_DIRECT_DOMAIN     "ap-guangzhou.iothub.tencentdevices.com"//"console.iotprivate.tencentcs.com/iotwss"
+#define QCLOUD_IOT_WEBSOCKET_MQTT_US_EAST_DOMAIN    "us-east.iothub.tencentdevices.com"
+#define QCLOUD_IOT_WEBSOCKET_MQTT_EUROPE_DOMAIN     "europe.iothub.tencentdevices.com"
+#define QCLOUD_IOT_WEBSOCKET_MQTT_AP_BANGKOK_DOMAIN "ap-bangkok.iothub.tencentdevices.com"
+
+#define QCLOUD_IOT_WEBSOCKET_MQTT_SERVER_PORT_TLS   443
+#define QCLOUD_IOT_WEBSOCKET_MQTT_SERVER_PORT_NOTLS 80
+
 /* server domain for dynamic registering device */
 #define DYNREG_LOG_SERVER_URL            "ap-guangzhou.gateway.tencentdevices.com"
 #define DYNREG_LOG_SERVER_US_EAST_URL    "us-east.gateway.tencentdevices.com"
@@ -45,7 +56,11 @@
 #define UPLOAD_LOG_URI_PATH       "/device/reportlog"
 #define LOG_UPLOAD_SERVER_PORT    80
 
-#define REMOTE_WS_SSH_PATH "/ssh/device"
+#define REMOTE_LOGIN_WEBSOCKET_SSH_URL            "ap-guangzhou.gateway.tencentdevices.com/ssh/device"
+#define REMOTE_LOGIN_WEBSOCKET_SSH_US_EAST_URL    "us-east.gateway.tencentdevices.com/ssh/device"
+#define REMOTE_LOGIN_WEBSOCKET_SSH_EUROPE_URL     "europe.gateway.tencentdevices.com/ssh/device"
+#define REMOTE_LOGIN_WEBSOCKET_SSH_AP_BANGKOK_URL "ap-bangkok.gateway.tencentdevices.com/ssh/device"
+
 #define LOCAL_SSH_PORT     22
 #define LOCAL_SSH_IP       "127.0.0.1"
 

sdk_src/internal_inc/utils_websocket_client.h

@@ -0,0 +1,41 @@
+/*
+ * Tencent is pleased to support the open source community by making IoT Hub available.
+ * Copyright (C) 2018-2020 THL A29 Limited, a Tencent company. All rights reserved.
+
+ * Licensed under the MIT License (the "License"); you may not use this file except in
+ * compliance with the License. You may obtain a copy of the License at
+ * http://opensource.org/licenses/MIT
+
+ * 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 UTILS_WEBSOCKET_CLIENT_H_
+#define UTILS_WEBSOCKET_CLIENT_H_
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef struct {
+    void *userdata;
+    void (*recv_data_err)(void *iotwsctx);
+    void (*send_data_err)(void *iotwsctx);
+    void (*proc_recv_msg_callback)(char *data, int datalen, void *iotwsctx);
+    void *  wslay_ctx;
+    Network network_stack;
+} UtilsIotWSClientCtx;
+
+int Utils_WSClient_connect(const char *protocol, UtilsIotWSClientCtx *ctx, const char *ws_custom_header);
+int  Utils_WSClient_send(UtilsIotWSClientCtx *ctx, char *data, int data_len);
+int  Utils_WSClient_recv(UtilsIotWSClientCtx *ctx);
+void Utils_WSClient_disconn(UtilsIotWSClientCtx *ctx);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* UTILS_WEBSOCKET_CLIENT_H_ */

sdk_src/network/network_interface.c

@@ -98,6 +98,18 @@ int network_init(Network *pNetwork)
             pNetwork->handle       = 0;
             break;
 #endif
+#endif
+
+#ifdef WEBSOCKET_MQTT
+        case NETWORK_WS_MQTT:
+            pNetwork->init         = network_websocket_mqtt_init;
+            pNetwork->connect      = network_websocket_mqtt_connect;
+            pNetwork->read         = network_websocket_mqtt_read;
+            pNetwork->write        = network_websocket_mqtt_write;
+            pNetwork->disconnect   = network_websocket_mqtt_disconnect;
+            pNetwork->is_connected = is_network_connected;
+            pNetwork->handle       = 0;
+            break;
 #endif
         default:
             Log_e("unknown network type: %d", pNetwork->type);