Release version 1.1.1

Author: chaurah

Changelog.md

@@ -1,4 +1,22 @@
 # Change Log
+
+## [1.1.1](https://github.com/aws/aws-iot-device-sdk-cpp/releases/tag/v1.1.1) (July 13th, 2017)
+
+Features:
+  - N/A
+
+Bugfixes/Improvements:
+  - Fixed issues:
+    - [#10](https://github.com/aws/aws-iot-device-sdk-cpp/issues/10) - Fix just-in-time-registration of device certs when using OpenSSL
+    - [#12](https://github.com/aws/aws-iot-device-sdk-cpp/issues/12) - Stop receiving duplicate messages when using QoS 1 
+    - [#17](https://github.com/aws/aws-iot-device-sdk-cpp/issues/17) - Disconnect callback should be called even when auto-reconnect is disabled
+    - [#18](https://github.com/aws/aws-iot-device-sdk-cpp/issues/18) - Clear subscriptions on disconnect 
+    - [#20](https://github.com/aws/aws-iot-device-sdk-cpp/issues/20) - Resubscribe to previously subscribed topic should not cause crash 
+    - [#23](https://github.com/aws/aws-iot-device-sdk-cpp/issues/23) - Fix memory leaks
+  - Included pull requests:
+    - [#24](https://github.com/aws/aws-iot-device-sdk-cpp/pull/24) - Fix cyclic refences
+    - [#26](https://github.com/aws/aws-iot-device-sdk-cpp/pull/26) - Fix subscription API documentaion
+  
 ## [1.1.0](https://github.com/aws/aws-iot-device-sdk-cpp/releases/tag/v1.1.0) (May 8th, 2017)
 
 Features:

KnownIssues.md

@@ -1,12 +1,13 @@
 # Known Issues/Limitations
-## [1.1.0](https://github.com/aws/aws-iot-device-sdk-cpp/releases/tag/v1.1.0) (May 8th, 2017)
+## [1.1.1](https://github.com/aws/aws-iot-device-sdk-cpp/releases/tag/v1.1.1) (July 13th, 2017)
 
 ### Common
 
   - Client Core - Reduce shared pointer usage, figure out ways to use fewer copy operations
   - Network Read - Add recovery options for out of sync buffers
   - Network Layer, Common - Currently, vector resize is called before the vector is passed for reading in data. Determine if a more flexible solution is possible with fewer allocations
   - Network Layer, OpenSSL - error handling for library API calls
+  - Network Layer, OpenSSL - memory leak 
   - Network Layer, WebSocket - Refactor WSLay and merge it with the WebSocket wrapper, improve testing
   - Network Layer, WebSocket - TLS Read and Write are highly inefficient in current implementation, improvements required
   - Network Layer, Common - Add support for IPv6, remove deprecated system API calls

common/ConfigCommon.cpp

@@ -31,6 +31,8 @@ namespace awsiotsdk {
     class ConfigCommon {
     protected:
         static util::JsonDocument sdk_config_json_;
+
+        static void LogParseError(const ResponseCode& response_code, const util::JsonDocument& config, util::String key);
     public:
         static uint16_t endpoint_mqtt_port_;
         static uint16_t endpoint_https_port_;

common/ConfigCommon.hpp

@@ -23,5 +23,6 @@
   "maximum_acks_to_wait_for": 32,
   "action_processing_rate_hz": 5,
   "maximum_outgoing_action_queue_length": 32,
-  "discover_action_timeout_msecs": 300000
+  "discover_action_timeout_msecs": 300000,
+  "switch_target_thing": "RobotArm_Thing"
 }

common/SwitchConfig.json

@@ -271,6 +271,22 @@ namespace awsiotsdk {
          */
         void DeleteExpiredAcks();
 
+        /**
+         * @brief Clears all registered Actions
+         *
+         * Utility method to remove all registered actions by the client.
+         * Also helps in breaking out of cyclic reference introduced when ::RegisterAction is called.
+         */
+        void ClearRegisteredActions();
+
+        /**
+         * @brief Clears all pending outbound Actions.
+         *
+         * Utility method to remove all pending outbound actions registered by the client.
+         * Also helps in breaking out of cyclic reference introduced when ::EnqueueOutboundAction is called.
+         */
+        void ClearOutboundActionQueue();
+
         /**
          * @brief Default Constructor
          */

include/ClientCoreState.hpp

@@ -169,7 +169,7 @@ namespace awsiotsdk {
          * Performs a MQTT Subscribe operation in blocking mode. Action timeout here is the time for which
          * the client waits for a response AFTER the request is sent.
          *
-         * @param p_subscribe_packet - Subscribe packet to use for the operation
+         * @param subscription_list - A list of subscriptions to use for the operation
          * @param action_response_timeout - Timeout in milliseconds within which response should be obtained after request is sent
          *
          * @return ResponseCode indicating status of request
@@ -225,7 +225,7 @@ namespace awsiotsdk {
          * activates Subscription if successful SUBACK is received. If not, the assigned Ack handler will be called
          * with the corrosponding ResponseCode
          *
-         * @param p_subscribe_packet - Subscribe packet to use for the operation
+         * @param subscription_list - A list of subscriptions to use for the operation
          * @param p_async_ack_handler - AsyncAck notification handler to be called when response for this request is processed
          * @param packet_id_out - Packet ID assigned to outgoing packet
          *

include/mqtt/Client.hpp

@@ -50,6 +50,8 @@ namespace awsiotsdk {
             std::chrono::milliseconds mqtt_command_timeout_;
 
             std::shared_ptr<ActionData> p_connect_data_;
+
+            std::atomic_bool trigger_disconnect_callback_;
         public:
             util::Map<util::String, std::shared_ptr<Subscription>> subscription_map_;
 
@@ -86,6 +88,9 @@ namespace awsiotsdk {
             bool IsPingreqPending() { return is_pingreq_pending_; }
             void SetPingreqPending(bool value) { is_pingreq_pending_ = value; }
 
+            bool isDisconnectCallbackPending() { return trigger_disconnect_callback_; }
+            void setDisconnectCallbackPending(bool value) { trigger_disconnect_callback_ = value; }
+
             virtual uint16_t GetNextPacketId();
             virtual uint16_t GetNextActionId() { return GetNextPacketId(); }
 

include/mqtt/ClientState.hpp

@@ -163,6 +163,8 @@ namespace awsiotsdk {
          * This class defines the Packet type used in MQTT to Acknowledge Publish requests
          */
         class PubackPacket : public Packet {
+        protected:
+            std::atomic_uint_fast16_t publish_packet_id_;
         public:
             // Ensure Default Constructor is deleted, default to move and copy constructors and assignment operators
             // Default virtual destructor
@@ -184,20 +186,23 @@ namespace awsiotsdk {
              *
              * @param packet_id Packet ID for this Puback
              */
-            PubackPacket(uint16_t packet_id);
+            PubackPacket(uint16_t publish_packet_id);
 
             /**
              * @brief Factory Create method
              * @param packet_id Packet ID for this Puback
              * @return nullptr on error, shared_ptr pointing to a created PubackPacket instance if successful
              */
-            static std::shared_ptr<PubackPacket> Create(uint16_t packet_id);
+            static std::shared_ptr<PubackPacket> Create(uint16_t publish_packet_id);
 
             /**
              * @brief Serialize this packet into a String
              * @return String containing serialized packet
              */
             util::String ToString();
+
+            uint16_t GetPublishPacketId() { return publish_packet_id_; }
+            void SetPublishPacketId(uint16_t publish_packet_id) { publish_packet_id_ = publish_packet_id; }
         };
 
         /**

include/mqtt/Publish.hpp

@@ -51,6 +51,7 @@ namespace awsiotsdk {
             flags_ = 0;
 
             is_connected_ = false;
+            requires_free_ = false;
         }
 
         bool MbedTLSConnection::IsPhysicalLayerConnected() {
@@ -96,6 +97,8 @@ namespace awsiotsdk {
             mbedtls_x509_crt_init(&clicert_);
             mbedtls_pk_init(&pkey_);
 
+            requires_free_ = true;
+
             AWS_LOG_INFO(MBEDTLS_WRAPPER_LOG_TAG, "...............................%d", MBEDTLS_SSL_MAX_CONTENT_LEN);
 
             AWS_LOG_INFO(MBEDTLS_WRAPPER_LOG_TAG, "....Seeding the random number generator...");
@@ -106,7 +109,7 @@ namespace awsiotsdk {
                 return ResponseCode::NETWORK_SSL_INIT_ERROR;
             }
 
-            AWS_LOG_INFO(MBEDTLS_WRAPPER_LOG_TAG, "....Loading the CA root certificate...");
+            AWS_LOG_INFO(MBEDTLS_WRAPPER_LOG_TAG, "....Loading the CA root certificate... %s", root_ca_location_.c_str());
             ret = mbedtls_x509_crt_parse_file(&cacert_, root_ca_location_.c_str());
             if (ret < 0) {
                 AWS_LOG_ERROR(MBEDTLS_WRAPPER_LOG_TAG,
@@ -181,11 +184,6 @@ namespace awsiotsdk {
             }
 
             mbedtls_ssl_conf_read_timeout(&conf_, static_cast<uint32_t>(tls_handshake_timeout_.count()));
-
-            if ((ret = mbedtls_ssl_setup(&ssl_, &conf_)) != 0) {
-                AWS_LOG_ERROR(MBEDTLS_WRAPPER_LOG_TAG, "Failed!!! mbedtls_ssl_setup returned -0x%x\n\n", -ret);
-                return ResponseCode::NETWORK_SSL_UNKNOWN_ERROR;
-            }
             if ((ret = mbedtls_ssl_set_hostname(&ssl_, endpoint_.c_str())) != 0) {
                 AWS_LOG_ERROR(MBEDTLS_WRAPPER_LOG_TAG, "Failed!!! mbedtls_ssl_set_hostname returned %d\n\n", ret);
                 return ResponseCode::NETWORK_SSL_UNKNOWN_ERROR;
@@ -194,6 +192,11 @@ namespace awsiotsdk {
             mbedtls_ssl_set_bio(&ssl_, &server_fd_, mbedtls_net_send, NULL, mbedtls_net_recv_timeout);
             AWS_LOG_INFO(MBEDTLS_WRAPPER_LOG_TAG, "Ok!");
 
+            if ((ret = mbedtls_ssl_setup(&ssl_, &conf_)) != 0) {
+                AWS_LOG_ERROR(MBEDTLS_WRAPPER_LOG_TAG, "Failed!!! mbedtls_ssl_setup returned -0x%x\n\n", -ret);
+                return ResponseCode::NETWORK_SSL_UNKNOWN_ERROR;
+            }
+
             AWS_LOG_INFO(MBEDTLS_WRAPPER_LOG_TAG, "\n\nSSL state connect : %d ", ssl_.state);
             AWS_LOG_INFO(MBEDTLS_WRAPPER_LOG_TAG, "....Performing the SSL/TLS handshake...");
             while ((ret = mbedtls_ssl_handshake(&ssl_)) != 0) {
@@ -311,10 +314,25 @@ namespace awsiotsdk {
         }
 
         ResponseCode MbedTLSConnection::DisconnectInternal() {
-            int ret = 0;
-            do {
-                ret = mbedtls_ssl_close_notify(&ssl_);
-            } while (ret == MBEDTLS_ERR_SSL_WANT_WRITE);
+            if (is_connected_) {
+                int ret = 0;
+                do {
+                    ret = mbedtls_ssl_close_notify(&ssl_);
+                } while (ret == MBEDTLS_ERR_SSL_WANT_WRITE);
+            }
+
+            if(requires_free_) {
+                mbedtls_net_free(&server_fd_);
+
+                mbedtls_x509_crt_free(&clicert_);
+                mbedtls_x509_crt_free(&cacert_);
+                mbedtls_pk_free(&pkey_);
+                mbedtls_ssl_free(&ssl_);
+                mbedtls_ssl_config_free(&conf_);
+                mbedtls_ctr_drbg_free(&ctr_drbg_);
+                mbedtls_entropy_free(&entropy_);
+                requires_free_ = false;
+            }
 
             is_connected_ = false;
 
@@ -324,19 +342,7 @@ namespace awsiotsdk {
         }
 
         MbedTLSConnection::~MbedTLSConnection() {
-            if (is_connected_) {
-                Disconnect();
-            }
-
-            mbedtls_net_free(&server_fd_);
-
-            mbedtls_x509_crt_free(&clicert_);
-            mbedtls_x509_crt_free(&cacert_);
-            mbedtls_pk_free(&pkey_);
-            mbedtls_ssl_free(&ssl_);
-            mbedtls_ssl_config_free(&conf_);
-            mbedtls_ctr_drbg_free(&ctr_drbg_);
-            mbedtls_entropy_free(&entropy_);
+            Disconnect();
         }
     }
 }