Added fuzzing for Telemetry (#1220)

* Added fuzzing for Telemetry (ProcessJsonFile)

* added additional exception handlers

Author: AhmedBM

.github/workflows/fuzzing-run.yml

@@ -74,7 +74,7 @@ jobs:
         with:
           container: ${{ steps.container.outputs.id }}
           working-directory: ${{ env.MOUNT }}/tests/fuzzer
-          cmd: set -o pipefail && ./osconfig-fuzzer -artifact_prefix=${{ env.MOUNT }}/output/artifacts/ -max_total_time=${{ inputs.timeout-seconds }} /tmp/corpus 2>&1 >/dev/null | tee ${{ env.MOUNT }}/output/osconfig-fuzzer.log
+          cmd: set -o pipefail && LSAN_OPTIONS=suppressions=${{ env.MOUNT }}/src/tests/fuzzer/lsan.suppressions ./osconfig-fuzzer -artifact_prefix=${{ env.MOUNT }}/output/artifacts/ -max_total_time=${{ inputs.timeout-seconds }} /tmp/corpus 2>&1 >/dev/null | tee ${{ env.MOUNT }}/output/osconfig-fuzzer.log
 
       - uses: actions/upload-artifact@v4
         if: success() || failure()

src/CMakeLists.txt

@@ -157,10 +157,10 @@ if (BUILD_FUZZER)
     message(STATUS "Fuzzer: Enabled")
     message(STATUS "Modified CXX flags: ${CMAKE_CXX_FLAGS}")
     message(STATUS "Modified C flags: ${CMAKE_C_FLAGS}")
-    add_subdirectory(tests)
 else()
     message(STATUS "Fuzzer: Disabled")
 endif()
+
 add_subdirectory(common)
 if (BUILD_ADAPTERS)
     add_subdirectory(adapters)
@@ -174,7 +174,7 @@ endif()
 
 if (BUILD_TELEMETRY)
     ExternalProject_Get_Property(telemetry-external BINARY_DIR)
-    set(TELEMETRY_TESTS_DIR ${BINARY_DIR}/lib/tests)
+    set(TELEMETRY_TESTS_DIR ${TELEMETRY_LIB_DIR}/tests)
     set(TELEMETRY_BIN_TESTS_DIR ${BINARY_DIR}/bin/tests)
     configure_file(
         ${CMAKE_SOURCE_DIR}/cmake/ExternalTests.cmake.in
@@ -186,6 +186,8 @@ if (BUILD_TELEMETRY)
             ${CMAKE_BINARY_DIR}/ExternalTests.cmake)
 endif()
 
+add_subdirectory(tests)
+
 message(STATUS "CMAKE_C_FLAGS: ${CMAKE_C_FLAGS}")
 message(STATUS "CMAKE_CXX_FLAGS: ${CMAKE_CXX_FLAGS}")
 

src/adapters/mc/CMakeLists.txt

@@ -13,6 +13,13 @@ if (BUILD_TELEMETRY)
             message(FATAL_ERROR "g++-5 not found in PATH, but required for 1DS SDK with GCC < 5.5")
         endif()
         set(CMAKE_ARGS -DCMAKE_C_COMPILER=gcc-5 -DCMAKE_CXX_COMPILER=g++-5)
+    elseif(BUILD_FUZZER)
+        set(CMAKE_ARGS
+            -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
+            -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
+            -DCMAKE_C_FLAGS=${CMAKE_C_FLAGS}
+            -DCMAKE_CXX_FLAGS=${CMAKE_CXX_FLAGS}
+        )
     endif()
     ExternalProject_Add(
         telemetry-external
@@ -32,6 +39,38 @@ if (BUILD_TELEMETRY)
             -DONEDS_CPP_SDK_VERSION=${ONEDS_CPP_SDK_VERSION}
     )
     ExternalProject_Get_Property(telemetry-external BINARY_DIR)
+
+    set(TELEMETRY_LIB_DIR ${BINARY_DIR}/lib CACHE PATH "Telemetry library directory" FORCE)
+    set(MAT_SDK_LIB ${BINARY_DIR}/1ds_install/lib)
+    set(MAT_SDK_INCLUDE ${BINARY_DIR}/1ds_install/include/mat)
+
+    set(VCPKG_PACKAGES_DIR "${VCPKG_INSTALLED_DIR}/${VCPKG_TARGET_TRIPLET}")
+    find_package(CURL REQUIRED NO_DEFAULT_PATH PATHS ${VCPKG_PACKAGES_DIR})
+    find_package(OpenSSL REQUIRED NO_DEFAULT_PATH PATHS ${VCPKG_PACKAGES_DIR})
+    find_package(Threads REQUIRED)
+    find_package(unofficial-sqlite3 REQUIRED NO_DEFAULT_PATH PATHS ${VCPKG_PACKAGES_DIR})
+    find_package(nlohmann_json REQUIRED NO_DEFAULT_PATH PATHS ${VCPKG_PACKAGES_DIR})
+
+    add_library(telemetry-interface INTERFACE)
+    add_dependencies(telemetry-interface telemetry-external)
+    target_link_libraries(telemetry-interface
+        INTERFACE
+            ${BINARY_DIR}/lib/libtelemetrylib.a
+            ${MAT_SDK_LIB}/libmat.a
+            unofficial::sqlite3::sqlite3
+            nlohmann_json::nlohmann_json
+            CURL::libcurl
+            OpenSSL::SSL
+            dl
+            ${CMAKE_THREAD_LIBS_INIT}
+    )
+    target_include_directories(telemetry-interface
+        INTERFACE
+            ${BINARY_DIR}
+            ${CMAKE_SOURCE_DIR}/common/telemetry/lib
+            ${MAT_SDK_INCLUDE}
+            ${TELEMETRY_LIB_DIR}
+    )
 endif()
 
 add_compile_options("-Wall;-Wextra;-Wunused;-Werror;-Wformat;-Wformat-security;-Wno-unused-result")

src/common/telemetry/lib/CMakeLists.txt

@@ -61,10 +61,12 @@ find_package(Threads REQUIRED)  # Threads can still use system
 find_package(unofficial-sqlite3 REQUIRED NO_DEFAULT_PATH PATHS ${VCPKG_PACKAGES_DIR})
 find_package(nlohmann_json REQUIRED NO_DEFAULT_PATH PATHS ${VCPKG_PACKAGES_DIR})
 
-include_directories(../../telemetry)
-add_subdirectory(../../parson ${CMAKE_CURRENT_BINARY_DIR}/parson)
-add_subdirectory(../../logging ${CMAKE_CURRENT_BINARY_DIR}/logging)
-add_subdirectory(../../commonutils ${CMAKE_CURRENT_BINARY_DIR}/commonutils)
+if(BUILD_EXTERNAL)
+    include_directories(../../telemetry)
+    add_subdirectory(../../parson ${CMAKE_CURRENT_BINARY_DIR}/parson)
+    add_subdirectory(../../logging ${CMAKE_CURRENT_BINARY_DIR}/logging)
+    add_subdirectory(../../commonutils ${CMAKE_CURRENT_BINARY_DIR}/commonutils)
+endif()
 
 # Add telemetry ingestion key (if defined)
 if(DEFINED ENV{OsConfigTelemetryApiKey} AND NOT "$ENV{OsConfigTelemetryApiKey}" STREQUAL "")
@@ -81,8 +83,10 @@ add_library(telemetrylib STATIC
 )
 add_dependencies(telemetrylib 1dscpplib)
 
-# commonutils is used which uses telemetry, create an alias to avoid name conflict
-add_library(telemetry ALIAS telemetrylib)
+if(BUILD_EXTERNAL)
+    # commonutils is used which uses telemetry, create an alias to avoid name conflict
+    add_library(telemetry ALIAS telemetrylib)
+endif()
 
 target_link_libraries(telemetrylib
     PUBLIC

src/common/telemetry/lib/Telemetry.cpp

@@ -35,7 +35,7 @@ TelemetryManager::TelemetryManager(bool enableDebug, std::chrono::seconds teardo
 
     status_t status = STATUS_SUCCESS;
     m_logManager.reset(LogManagerProvider::CreateLogManager(m_logConfig, status));
-    if (STATUS_SUCCESS != status)
+    if ((STATUS_SUCCESS != status) || !m_logManager)
     {
         OsConfigLogError(m_log, "Telemetry initialization failed. status=%d", status);
         throw std::runtime_error("Telemetry initialization failed");
@@ -166,9 +166,19 @@ bool TelemetryManager::ProcessJsonLine(const std::string& jsonLine)
     {
         jsonObject = nlohmann::json::parse(jsonLine);
     }
-    catch(const nlohmann::json::parse_error& e)
+    catch(const nlohmann::json::exception& e)
+    {
+        OsConfigLogError(m_log, "JSON exception: %s", e.what());
+        return false;
+    }
+    catch(const std::exception& e)
+    {
+        OsConfigLogError(m_log, "Exception during JSON parsing: %s", e.what());
+        return false;
+    }
+    catch(...)
     {
-        // Ignore invalid JSON lines
+        OsConfigLogError(m_log, "Unknown exception during JSON parsing");
         return false;
     }
 

src/tests/fuzzer/CMakeLists.txt

@@ -19,6 +19,7 @@ target_link_libraries(osconfig-fuzzer PRIVATE
     securitybaselinelib
     complianceenginelib
     parsonlib
+    $<$<BOOL:${BUILD_TELEMETRY}>:telemetry-interface>
 )
 
 target_compile_definitions(osconfig-fuzzer PRIVATE

src/tests/fuzzer/lsan.suppressions

@@ -0,0 +1,5 @@
+# LeakSanitizer suppressions for fuzzer
+# Suppress leaks from external dependencies that are not part of our codebase
+
+# SQLite3 internal allocations
+leak:sqlite3MemMalloc

src/tests/fuzzer/seed_corpus/ProcessJsonFile.target

@@ -0,0 +1 @@
+ProcessJsonFile.{"EventName":"TestEvent","Parameter1":"value1"}