fix: Check if all required fields are present in json payload before reading them (#51)

Author: tomasz-blasz

.transport.version

@@ -1 +1 @@
-1.1.2
+1.1.3

CHANGELOG.md

@@ -1,8 +1,10 @@
 ## [0.5.1](https://github.com/rdkcentral/firebolt-cpp-client/compare/v0.5.0...v0.5.1)
 
 ### Changed
-- **Breaking**: In v0.5.0, `AgePolicy` was moved to the `Firebolt` namespace and to the `common_types.h` header file. References must be changed
-  from `Firebolt::Discovery::AgePolicy` to `Firebolt::AgePolicy`, and the include must be added (`#include <firebolt/common_types.h>`).
+- Updated Firebolt C++ Transport dependency to `v1.1.3`
+
+### Fixed
+- Prevented a crash when a mandatory field was missing from the JSON payload
 
 ## [0.5.0](https://github.com/rdkcentral/firebolt-cpp-client/compare/v0.4.0...v0.5.0)
 
@@ -18,6 +20,8 @@
 - **Breaking**: Aligned types with the latest specification updates:
   - `integer` changed to unsigned (`uint32_t`)
   - `float` changed to `double`
+- **Breaking**: `AgePolicy` was moved to the `Firebolt` namespace and to the `common_types.h` header file. References must be changed
+  from `Firebolt::Discovery::AgePolicy` to `Firebolt::AgePolicy`, and the include must be added (`#include <firebolt/common_types.h>`).
 - Specify the build version and ABI version
 - Updated Firebolt C++ Transport dependency to `v1.1.2`
 

CMakeLists.txt

@@ -80,7 +80,7 @@ else()
         FetchContent_Declare(
             FireboltTransport
             URL "https://github.com/rdkcentral/firebolt-cpp-transport/releases/download/v${FIREBOLT_TRANSPORT_VERSION}/firebolt-cpp-transport-${FIREBOLT_TRANSPORT_VERSION}.tar.gz"
-            URL_HASH "SHA256=892f08b1c532fc5ac0029d759612dd2dc1b521d43882a0f70c22a02ff6ca05e7"
+            URL_HASH "SHA256=0a0c9394395a514d3ba6931a6c656886523c6b3f038b0cb991c27c837f0e506e"
             DOWNLOAD_EXTRACT_TIMESTAMP true
         )
         set(ENABLE_TESTS_ORIG ${ENABLE_TESTS})

src/json_types/accessibility.h

@@ -29,6 +29,10 @@ class ClosedCaptionsSettings : public Firebolt::JSON::NL_Json_Basic<::Firebolt::
 public:
     void fromJson(const nlohmann::json& json) override
     {
+        if (!checkRequiredFields(json, {"enabled", "preferredLanguages"}))
+        {
+            throw std::invalid_argument("Missing required fields in JSON");
+        }
         enabled_ = json["enabled"].get<bool>();
         preferredLanguages_ = json["preferredLanguages"].get<std::vector<std::string>>();
     }
@@ -47,6 +51,10 @@ class VoiceGuidanceSettings : public Firebolt::JSON::NL_Json_Basic<::Firebolt::A
 public:
     void fromJson(const nlohmann::json& json) override
     {
+        if (!checkRequiredFields(json, {"enabled", "rate", "navigationHints"}))
+        {
+            throw std::invalid_argument("Missing required fields in JSON");
+        }
         enabled_ = json["enabled"].get<bool>();
         rate_ = json["rate"].get<double>();
         navigationHints_ = json["navigationHints"].get<bool>();

src/json_types/advertising.h

@@ -30,6 +30,10 @@ class IfaJson : public Firebolt::JSON::NL_Json_Basic<::Firebolt::Advertising::If
 public:
     void fromJson(const nlohmann::json& json) override
     {
+        if (!checkRequiredFields(json, {"ifa", "ifa_type", "lmt"}))
+        {
+            throw std::invalid_argument("Missing required fields in JSON");
+        }
         ifa = json["ifa"].get<std::string>();
         ifa_type = json["ifa_type"].get<std::string>();
         lmt = json["lmt"].get<std::string>();

src/json_types/device.h

@@ -47,6 +47,10 @@ class HDRFormat : public Firebolt::JSON::NL_Json_Basic<::Firebolt::Device::HDRFo
 public:
     void fromJson(const nlohmann::json& json) override
     {
+        if (!checkRequiredFields(json, {"hdr10", "hdr10Plus", "dolbyVision", "hlg"}))
+        {
+            throw std::invalid_argument("Missing required fields in JSON");
+        }
         hdrFormat_.hdr10 = json["hdr10"].get<bool>();
         hdrFormat_.hdr10Plus = json["hdr10Plus"].get<bool>();
         hdrFormat_.dolbyVision = json["dolbyVision"].get<bool>();

src/json_types/display.h

@@ -31,6 +31,10 @@ class DisplaySizeJson : public Firebolt::JSON::NL_Json_Basic<::Firebolt::Display
 public:
     void fromJson(const nlohmann::json& json) override
     {
+        if (!checkRequiredFields(json, {"width", "height"}))
+        {
+            throw std::invalid_argument("Missing required fields in JSON");
+        }
         width_ = json["width"].get<uint32_t>();
         height_ = json["height"].get<uint32_t>();
     }

src/json_types/lifecycle.h

@@ -55,6 +55,10 @@ class StateChange : public Firebolt::JSON::NL_Json_Basic<::Firebolt::Lifecycle::
 public:
     void fromJson(const nlohmann::json& json) override
     {
+        if (!checkRequiredFields(json, {"oldState", "newState"}))
+        {
+            throw std::invalid_argument("Missing required fields in JSON");
+        }
         oldState_ = LifecycleStateEnum.at(json["oldState"]);
         newState_ = LifecycleStateEnum.at(json["newState"]);
     }

src/json_types/stats.h

@@ -29,6 +29,11 @@ class MemoryInfo : public Firebolt::JSON::NL_Json_Basic<::Firebolt::Stats::Memor
 public:
     void fromJson(const nlohmann::json& json) override
     {
+        if (!checkRequiredFields(json,
+                                 {"userMemoryUsedKiB", "userMemoryLimitKiB", "gpuMemoryUsedKiB", "gpuMemoryLimitKiB"}))
+        {
+            throw std::invalid_argument("Missing required fields in JSON");
+        }
         userMemoryUsed = json["userMemoryUsedKiB"].get<uint32_t>();
         userMemoryLimit = json["userMemoryLimitKiB"].get<uint32_t>();
         gpuMemoryUsed = json["gpuMemoryUsedKiB"].get<uint32_t>();

src/json_types/texttospeech.h

@@ -36,6 +36,10 @@ class ListVoicesResponse : public Firebolt::JSON::NL_Json_Basic<::Firebolt::Text
 public:
     void fromJson(const nlohmann::json& json) override
     {
+        if (!checkRequiredFields(json, {"TTS_Status", "voices"}))
+        {
+            throw std::invalid_argument("Missing required fields in JSON");
+        }
         ttsStatus_ = json["TTS_Status"].get<uint32_t>();
         voices_.clear();
         for (const auto& voice : json["voices"])
@@ -56,7 +60,14 @@ class ListVoicesResponse : public Firebolt::JSON::NL_Json_Basic<::Firebolt::Text
 class SpeechIdEvent : public Firebolt::JSON::NL_Json_Basic<::Firebolt::TextToSpeech::SpeechIdEvent>
 {
 public:
-    void fromJson(const nlohmann::json& json) override { speechId_ = json["speechid"].get<uint32_t>(); }
+    void fromJson(const nlohmann::json& json) override
+    {
+        if (!checkRequiredFields(json, {"speechid"}))
+        {
+            throw std::invalid_argument("Missing required fields in JSON");
+        }
+        speechId_ = json["speechid"].get<uint32_t>();
+    }
     ::Firebolt::TextToSpeech::SpeechIdEvent value() const override
     {
         return ::Firebolt::TextToSpeech::SpeechIdEvent{speechId_};
@@ -71,6 +82,10 @@ class SpeechResponse : public Firebolt::JSON::NL_Json_Basic<::Firebolt::TextToSp
 public:
     void fromJson(const nlohmann::json& json) override
     {
+        if (!checkRequiredFields(json, {"speechid", "TTS_Status", "success"}))
+        {
+            throw std::invalid_argument("Missing required fields in JSON");
+        }
         speechId_ = json["speechid"].get<uint32_t>();
         ttsStatus_ = json["TTS_Status"].get<uint32_t>();
         success_ = json["success"].get<bool>();
@@ -91,6 +106,10 @@ class SpeechStateResponse : public Firebolt::JSON::NL_Json_Basic<::Firebolt::Tex
 public:
     void fromJson(const nlohmann::json& json) override
     {
+        if (!checkRequiredFields(json, {"speechstate", "TTS_Status", "success"}))
+        {
+            throw std::invalid_argument("Missing required fields in JSON");
+        }
         speechState_ = static_cast<SpeechState>(json["speechstate"].get<uint32_t>());
         ttsStatus_ = json["TTS_Status"].get<uint32_t>();
         success_ = json["success"].get<bool>();
@@ -111,6 +130,10 @@ class TTSStatusResponse : public Firebolt::JSON::NL_Json_Basic<::Firebolt::TextT
 public:
     void fromJson(const nlohmann::json& json) override
     {
+        if (!checkRequiredFields(json, {"TTS_Status", "success"}))
+        {
+            throw std::invalid_argument("Missing required fields in JSON");
+        }
         ttsStatus_ = json["TTS_Status"].get<uint32_t>();
         success_ = json["success"].get<bool>();
     }