Deepstream 5.0 Subscription Implementation

aws_protocol_adaptor/device_client/Makefile

@@ -61,6 +61,9 @@ EXTERNAL_LIBS += -L$(TLS_LIB_DIR)
 LD_FLAG += -Wl,-rpath,$(TLS_LIB_DIR)
 LD_FLAG += -ldl $(TLS_LIB_DIR)/libmbedtls.a $(TLS_LIB_DIR)/libmbedcrypto.a $(TLS_LIB_DIR)/libmbedx509.a -lpthread
 
+# SSL Libs
+SSL_LIBS = -l:libssl.a -l:libcrypto.a
+
 # GLibs
 DP_SOURCE_DIR = ../../..
 NVDS_VERSION:=4.0
@@ -98,7 +101,7 @@ MAKE_OBJ_CMD = $(CC) -c -fPIC $(SRC_FILES) $(COMPILER_FLAGS) $(LD_FLAG) $(EXTERN
 
 OBJS:=./*.o
 TLS_OBJS=$(TLS_LIB_DIR)/*.o
-MAKE_LIB_CMD = $(CC) -shared -fPIC -o libnvds_aws_proto.so $(OBJS) $(TLS_OBJS) ${LIBS}
+MAKE_LIB_CMD = $(CC) -shared -fPIC -o libnvds_aws_proto.so $(OBJS) $(TLS_OBJS) $(SSL_LIBS) ${LIBS}
 MAKE_TEST_CMD = $(CC) $(SRC_FILES) $(APP_SRC_FILES) $(COMPILER_FLAGS) $(LD_FLAG) $(EXTERNAL_LIBS) $(INCLUDE_ALL_DIRS) $(LIBS) -o $(APP_NAME)
 
 all:

aws_protocol_adaptor/device_client/aws_iot_config.h

@@ -28,24 +28,27 @@
 #define AWS_IOT_MAX_CERT_PATH_LEN 200
 #define AWS_IOT_MAX_PRIVATE_KEY_PATH_LEN 200
 
-#define AWS_IOT_MQTT_TX_BUF_LEN 4096		  ///< Any time a message is sent out through the MQTT layer. The message is copied into this buffer anytime a publish is done. This will also be used in the case of Thing Shadow
-#define AWS_IOT_MQTT_RX_BUF_LEN 512			  ///< Any message that comes into the device should be less than this buffer size. If a received message is bigger than this buffer size the message will be dropped.
-#define AWS_IOT_MQTT_TOPIC_BUF_LEN 257		  ///< Maximum len of topics in AWS MQTT server + EOS
+#define AWS_IOT_MQTT_TX_BUF_LEN 4096          ///< Any time a message is sent out through the MQTT layer. The message is copied into this buffer anytime a publish is done. This will also be used in the case of Thing Shadow
+#define AWS_IOT_MQTT_RX_BUF_LEN 512           ///< Any message that comes into the device should be less than this buffer size. If a received message is bigger than this buffer size the message will be dropped.
+#define AWS_IOT_MQTT_TOPIC_BUF_LEN 257        ///< Maximum len of topics in AWS MQTT server + EOS
 #define AWS_IOT_CLIENT_YIELD_WAIT_TIME 10     ///< Maximum number of milliseconds to pass thread execution to the MQTT client.
 #define AWS_IOT_MQTT_NUM_SUBSCRIBE_HANDLERS 5 ///< Maximum number of topic filters the MQTT client can handle at any given time. This should be increased appropriately when using Thing Shadow
 
 #define AWS_IOT_MAX_SEND_INTERVAL_SEC 120 ///< Have to yield every this amount of time before time-out disconnect
+#define MAX_SUBSCRIPTIONS 50
+#define NVDS_MSGAPI_VERSION "2.0"
+#define NVDS_MSGAPI_PROTOCOL "AWS"
 
 // Thing Shadow specific configs
-#define SHADOW_MAX_SIZE_OF_RX_BUFFER (AWS_IOT_MQTT_RX_BUF_LEN + 1)										 ///< Maximum size of the SHADOW buffer to store the received Shadow message, including terminating NULL byte.
-#define MAX_SIZE_OF_UNIQUE_CLIENT_ID_BYTES 80															 ///< Maximum size of the Unique Client Id. For More info on the Client Id refer \ref response "Acknowledgments"
-#define MAX_SIZE_CLIENT_ID_WITH_SEQUENCE MAX_SIZE_OF_UNIQUE_CLIENT_ID_BYTES + 10						 ///< This is size of the extra sequence number that will be appended to the Unique client Id
-#define MAX_SIZE_CLIENT_TOKEN_CLIENT_SEQUENCE MAX_SIZE_CLIENT_ID_WITH_SEQUENCE + 20						 ///< This is size of the the total clientToken key and value pair in the JSON
-#define MAX_ACKS_TO_COMEIN_AT_ANY_GIVEN_TIME 10															 ///< At Any given time we will wait for this many responses. This will correlate to the rate at which the shadow actions are requested
-#define MAX_THINGNAME_HANDLED_AT_ANY_GIVEN_TIME 10														 ///< We could perform shadow action on any thing Name and this is maximum Thing Names we can act on at any given time
-#define MAX_JSON_TOKEN_EXPECTED 120																		 ///< These are the max tokens that is expected to be in the Shadow JSON document. Include the metadata that gets published
-#define MAX_SHADOW_TOPIC_LENGTH_WITHOUT_THINGNAME 60													 ///< All shadow actions have to be published or subscribed to a topic which is of the format $aws/things/{thingName}/shadow/update/accepted. This refers to the size of the topic without the Thing Name
-#define MAX_SIZE_OF_THING_NAME 20																		 ///< The Thing Name should not be bigger than this value. Modify this if the Thing Name needs to be bigger
+#define SHADOW_MAX_SIZE_OF_RX_BUFFER (AWS_IOT_MQTT_RX_BUF_LEN + 1)                                       ///< Maximum size of the SHADOW buffer to store the received Shadow message, including terminating NULL byte.
+#define MAX_SIZE_OF_UNIQUE_CLIENT_ID_BYTES 80                                                            ///< Maximum size of the Unique Client Id. For More info on the Client Id refer \ref response "Acknowledgments"
+#define MAX_SIZE_CLIENT_ID_WITH_SEQUENCE MAX_SIZE_OF_UNIQUE_CLIENT_ID_BYTES + 10                         ///< This is size of the extra sequence number that will be appended to the Unique client Id
+#define MAX_SIZE_CLIENT_TOKEN_CLIENT_SEQUENCE MAX_SIZE_CLIENT_ID_WITH_SEQUENCE + 20                      ///< This is size of the the total clientToken key and value pair in the JSON
+#define MAX_ACKS_TO_COMEIN_AT_ANY_GIVEN_TIME 10                                                          ///< At Any given time we will wait for this many responses. This will correlate to the rate at which the shadow actions are requested
+#define MAX_THINGNAME_HANDLED_AT_ANY_GIVEN_TIME 10                                                       ///< We could perform shadow action on any thing Name and this is maximum Thing Names we can act on at any given time
+#define MAX_JSON_TOKEN_EXPECTED 120                                                                      ///< These are the max tokens that is expected to be in the Shadow JSON document. Include the metadata that gets published
+#define MAX_SHADOW_TOPIC_LENGTH_WITHOUT_THINGNAME 60                                                     ///< All shadow actions have to be published or subscribed to a topic which is of the format $aws/things/{thingName}/shadow/update/accepted. This refers to the size of the topic without the Thing Name
+#define MAX_SIZE_OF_THING_NAME 20                                                                        ///< The Thing Name should not be bigger than this value. Modify this if the Thing Name needs to be bigger
 #define MAX_SHADOW_TOPIC_LENGTH_BYTES MAX_SHADOW_TOPIC_LENGTH_WITHOUT_THINGNAME + MAX_SIZE_OF_THING_NAME ///< This size includes the length of topic with Thing Name
 
 // Auto Reconnect specific config

aws_protocol_adaptor/device_client/aws_nvmsgbroker.c

@@ -33,20 +33,29 @@
 #include "aws_config_parser.h"
 #include "nvds_msgapi.h"
 #include "aws_nvmsgbroker.h"
+#include <openssl/sha.h>
+
+#define SHA256_FILE_BUFLEN 32768
+#define SHA256_STRLEN SHA256_DIGEST_LENGTH * 2 + 1
 
 NvDsMsgApiHandle (*nvds_msgapi_connect_ptr)(char *connection_str, nvds_msgapi_connect_cb_t connect_cb, char *config_path);
 NvDsMsgApiErrorType (*nvds_msgapi_send_ptr)(NvDsMsgApiHandle conn, char *topic, const uint8_t *payload, size_t nbuf);
 NvDsMsgApiErrorType (*nvds_msgapi_disconnect_ptr)(NvDsMsgApiHandle h_ptr);
+NvDsMsgApiErrorType (*nvds_msgapi_connection_signature_ptr)(char *connection_str, char *config_path, char *output_str, int max_len);
 static GMutex thread_mutex;
 static GQueue *work_queue;
-static struct timespec last_send_time_stamp;   // this is to make sure we send or yield frequent enough so we do not get disconnected.
+static struct timespec last_send_time_stamp; // this is to make sure we send or yield frequent enough so we do not get disconnected.
 static nvds_msgapi_connect_cb_t disconnect_cb; // disconnect handler provided by connect thread
+static nvds_msgapi_subscribe_request_cb_t nvds_cb; // msgapi subscribe callback handler
+static char *subscribed_topics[MAX_SUBSCRIPTIONS]; // to store the subscribed topics in order to be used during unsubscribe operation
+static size_t num_subscriptions = 0; // number of registered subscriptions
 
 /* ************************************************************************* */
 // Connect function def
 /* ************************************************************************* */
 
-static void disconnectCallbackHandler(AWS_IoT_Client *pClient, void *data)
+static void
+disconnectCallbackHandler(AWS_IoT_Client *pClient, void *data)
 {
 	IOT_WARN("MQTT Disconnect");
 	IoT_Error_t rc = FAILURE;
@@ -83,7 +92,7 @@ NvDsMsgApiHandle nvds_msgapi_connect(char *connection_str, nvds_msgapi_connect_c
 	disconnect_cb = connect_cb;
 	if (config_path == NULL)
 	{
-		IOT_ERROR("Essensial args missing for function nvds_msgapi_connect\n");
+		IOT_ERROR("Essential args missing for function nvds_msgapi_connect\n");
 		return NULL;
 	}
 
@@ -142,11 +151,21 @@ NvDsMsgApiErrorType nvds_msgapi_disconnect(NvDsMsgApiHandle h_ptr)
 {
 	if ((h_ptr == NULL))
 	{
-		IOT_ERROR("Essensial args missing for function nvds_msgapi_disconnect\n");
+		IOT_ERROR("Essential args missing for function nvds_msgapi_disconnect\n");
 		return NVDS_MSGAPI_ERR;
 	}
 	IoT_Error_t rc = FAILURE;
 	AWS_IoT_Client *client = (AWS_IoT_Client *)h_ptr;
+	for (int i = 0; i < num_subscriptions; i++)
+	{
+		rc = aws_iot_mqtt_unsubscribe(client, subscribed_topics[i], strlen(subscribed_topics[i]));
+		if (SUCCESS != rc)
+		{
+			IOT_ERROR("Unable to unsubscribe, error: %d\n", rc);
+		}
+	}
+	IOT_INFO("Successfully unsubscribed");
+
 	rc = aws_iot_mqtt_disconnect(client);
 	if (SUCCESS != rc)
 	{
@@ -180,7 +199,7 @@ NvDsMsgApiErrorType nvds_msgapi_send(NvDsMsgApiHandle conn, char *topic, const u
 {
 	if ((conn == NULL) || (topic == NULL) || (payload == NULL) || (nbuf == 0))
 	{
-		IOT_ERROR("Essensial args missing for function nvds_msgapi_send\n");
+		IOT_ERROR("Essential args missing for function nvds_msgapi_send\n");
 		return NVDS_MSGAPI_ERR;
 	}
 	AWS_IoT_Client *client = (AWS_IoT_Client *)conn;
@@ -217,7 +236,7 @@ NvDsMsgApiErrorType nvds_msgapi_send_async(NvDsMsgApiHandle h_ptr, char *topic,
 {
 	if ((h_ptr == NULL) || (topic == NULL) || (payload == NULL) || (nbuf == 0))
 	{
-		IOT_ERROR("Essensial args missing for function nvds_msgapi_send: %d, %d, %d, %d\n", (h_ptr == NULL), (topic == NULL), (payload == NULL), (nbuf == 0));
+		IOT_ERROR("Essential args missing for function nvds_msgapi_send: %d, %d, %d, %d\n", (h_ptr == NULL), (topic == NULL), (payload == NULL), (nbuf == 0));
 		return NVDS_MSGAPI_ERR;
 	}
 	Work *work_node = g_malloc(sizeof(Work));
@@ -243,6 +262,43 @@ NvDsMsgApiErrorType nvds_msgapi_send_async(NvDsMsgApiHandle h_ptr, char *topic,
 	return NVDS_MSGAPI_OK;
 }
 
+void nvds_cb_wrapped(AWS_IoT_Client *pClient, char *pTopicName, uint16_t topicNameLen, IoT_Publish_Message_Params *pParams, void *pClientData)
+{
+	IOT_INFO("Subscribe callback");
+	nvds_cb(NVDS_MSGAPI_OK, pParams->payload, pParams->payloadLen, pTopicName, pClientData);
+}
+
+NvDsMsgApiErrorType nvds_msgapi_subscribe(NvDsMsgApiHandle h_ptr, char **topics, int num_topics, nvds_msgapi_subscribe_request_cb_t cb, void *user_ctx)
+{
+	IOT_INFO("Subscribe called\n");
+	if ((h_ptr == NULL) || (topics == NULL) || (num_topics <= 0))
+	{
+		IOT_ERROR("Essential args missing for function nvds_msgapi_subscribe: %d, %d, %d\n", (h_ptr == NULL), (topics == NULL), (num_topics == 0));
+		return NVDS_MSGAPI_ERR;
+	}
+	if (!cb)
+	{
+		IOT_ERROR("Callback function for nvds_msgapi_subscribe cannot be NULL\n");
+		return NVDS_MSGAPI_ERR;
+	}
+	nvds_cb = cb;
+	IoT_Error_t rc = FAILURE;
+	AWS_IoT_Client *client = (AWS_IoT_Client *)h_ptr;
+	for (int i = 0; i < num_topics; i++)
+	{
+		rc = aws_iot_mqtt_subscribe(client, topics[i], strlen(topics[i]), QOS0, nvds_cb_wrapped, user_ctx);
+		if (SUCCESS != rc)
+		{
+			IOT_ERROR("Unable to subscribe, error: %d\n", rc);
+			return NVDS_MSGAPI_ERR;
+		}
+		subscribed_topics[i] = topics[i];
+		num_subscriptions++;
+	}
+	IOT_INFO("Successfully subscribed");
+	return NVDS_MSGAPI_OK;
+}
+
 /* ************************************************************************* */
 // Do Work function def
 /* ************************************************************************* */
@@ -277,7 +333,8 @@ void nvds_msgapi_do_work(NvDsMsgApiHandle h_ptr)
 		}
 		return;
 	}
-	while (! g_queue_is_empty(work_queue)){
+	while (!g_queue_is_empty(work_queue))
+	{
 		Work *work_node = (Work *)g_queue_pop_head(work_queue);
 		AWS_IoT_Client *client = (AWS_IoT_Client *)work_node->h_ptr;
 		rc = _mqtt_msg_send(client, work_node->topic, work_node->payload, work_node->payload_size);
@@ -291,7 +348,8 @@ void nvds_msgapi_do_work(NvDsMsgApiHandle h_ptr)
 			g_free(work_node);
 			return;
 		}
-		if (work_node->call_back_handler != NULL){
+		if (work_node->call_back_handler != NULL)
+		{
 			IOT_INFO("Pointer callback.");
 			work_node->call_back_handler(work_node->user_ptr, NVDS_MSGAPI_OK);
 		}
@@ -300,3 +358,131 @@ void nvds_msgapi_do_work(NvDsMsgApiHandle h_ptr)
 	last_send_time_stamp = current_time_stamp;
 	return;
 }
+
+char *nvds_msgapi_getversion()
+{
+	return NVDS_MSGAPI_VERSION;
+}
+
+char *nvds_msgapi_get_protocol_name()
+{
+	return NVDS_MSGAPI_PROTOCOL;
+}
+
+bool is_valid_connection_str(char *conn_str)
+{
+	char *burl = "", *bport = "";
+	if (conn_str == NULL)
+	{
+		IOT_ERROR("connection string cant be NULL");
+		return false;
+	}
+
+	int i = 0;
+
+	char *token = strtok(conn_str, ";");
+	char *data[2];
+
+	while (token)
+	{
+		data[i++] = token;
+		token = strtok(NULL, ";");
+	}
+	for (i = 0; i < 2; i++)
+	{
+		printf("%s\n", data[i]);
+	}
+	burl = data[0];
+	bport = data[1];
+
+	if (burl == "" || bport == "")
+	{
+		IOT_ERROR("connection string is invalid. hostname or port is empty\n");
+		return false;
+	}
+	return true;
+}
+
+int cfg_file_sha256(SHA256_CTX *sha256, char *cfg_path) 
+{
+	FILE *file;
+	unsigned char buffer[SHA256_FILE_BUFLEN];
+	int bytes_read = 0;
+	int read_err = 0;
+
+	if (!(file = fopen(cfg_path, "rb"))) 
+	{
+		IOT_ERROR("Failed to open configuration file %s\n", cfg_path);
+		return -1;
+	}
+
+	while ((bytes_read = fread(buffer, 1, sizeof(buffer), file)))
+	{
+		SHA256_Update(sha256, buffer, bytes_read);
+	}
+
+	read_err = ferror(file);
+	fclose(file);
+
+	if (read_err != 0) 
+	{
+		IOT_ERROR("Reading configuration file failed with error code %d\n", read_err);
+		return read_err;
+	}
+
+	return 0;
+}
+
+int generate_sha256_hash(char *output_str, char *conn_str, char *cfg_path)
+{
+	SHA256_CTX sha256;
+	unsigned char hashval[SHA256_DIGEST_LENGTH];
+
+	SHA256_Init(&sha256);
+
+	SHA256_Update(&sha256, conn_str, strlen(conn_str));
+
+	if (cfg_file_sha256(&sha256, cfg_path) != 0)
+	{
+		IOT_ERROR("Failed to generate config file hash\n");
+		return -1;
+	}
+
+	SHA256_Final(hashval, &sha256);
+	for (int i = 0; i < SHA256_DIGEST_LENGTH; i++)
+	{
+		sprintf(output_str + (i * 2), "%02x", hashval[i]);
+	}
+
+	return 0;
+}
+
+NvDsMsgApiErrorType nvds_msgapi_connection_signature(char *broker_str, char *cfg, char *output_str, int max_len)
+{
+	// Value of output_str must be empty string if operation is unsuccessful
+	strcpy(output_str, ""); 
+
+	if (broker_str == NULL || cfg == NULL)
+	{
+		IOT_ERROR("Must specify broker_str and cfg\n");
+		return NVDS_MSGAPI_ERR;
+	}
+
+	if (max_len < SHA256_STRLEN) 
+	{
+		IOT_ERROR("Insufficient output string length. Need %d, got %d", SHA256_STRLEN, max_len);
+		return NVDS_MSGAPI_ERR;
+	}
+
+	if (!is_valid_connection_str(broker_str))
+	{
+		return NVDS_MSGAPI_ERR;
+	}
+
+	if (generate_sha256_hash(output_str, broker_str, cfg) != 0)
+	{
+		return NVDS_MSGAPI_ERR;
+	}
+
+	return NVDS_MSGAPI_OK;
+}

aws_protocol_adaptor/device_client/aws_nvmsgbroker.h

@@ -41,4 +41,8 @@ NvDsMsgApiHandle nvds_msgapi_connect(char *connection_str, nvds_msgapi_connect_c
 NvDsMsgApiErrorType nvds_msgapi_disconnect(NvDsMsgApiHandle h_ptr);
 NvDsMsgApiErrorType nvds_msgapi_send(NvDsMsgApiHandle conn, char *topic, const uint8_t *payload, size_t nbuf);
 NvDsMsgApiErrorType nvds_msgapi_send_async(NvDsMsgApiHandle h_ptr, char *topic, const uint8_t *payload, size_t nbuf, nvds_msgapi_send_cb_t send_callback, void *user_ptr);
+NvDsMsgApiErrorType nvds_msgapi_subscribe(NvDsMsgApiHandle h_ptr, char **topics, int num_topics, nvds_msgapi_subscribe_request_cb_t cb, void *user_ctx);
 void nvds_msgapi_do_work(NvDsMsgApiHandle h_ptr);
+char *nvds_msgapi_getversion(void);
+char *nvds_msgapi_get_protocol_name(void);
+NvDsMsgApiErrorType nvds_msgapi_connection_signature(char *broker_str, char *cfg, char *output_str, int max_len);