fuzz: Add fuzz harnesses for string/crc api's (#801)

CMakeLists.txt

@@ -14,6 +14,7 @@ endif()
 project(etl VERSION ${ETL_VERSION} LANGUAGES CXX)
 
 option(BUILD_TESTS "Build unit tests" OFF)
+option(BUILD_FUZZ_TESTS "Build fuzz tests" OFF)
 option(NO_STL "No STL" OFF)
 # There is a bug on old gcc versions for some targets that causes all system headers
 # to be implicitly wrapped with 'extern "C"'
@@ -80,3 +81,20 @@ if (BUILD_TESTS)
     enable_testing()
     add_subdirectory(test)
 endif()
+
+if (BUILD_FUZZ_TESTS AND CMAKE_CXX_COMPILER_ID MATCHES "Clang")
+    # Determine the flags for fuzzing. Use OSS-Fuzz's configuration if available, otherwise fall back to defaults.
+    if(DEFINED ENV{LIB_FUZZING_ENGINE})
+        set(FUZZING_ENGINE $ENV{LIB_FUZZING_ENGINE})
+        set(FUZZING_COMPILE_FLAGS "")
+        set(FUZZING_LINK_FLAGS "${FUZZING_ENGINE}")
+    else()
+        # Instrument all source code for fuzzing.
+        set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=fuzzer-no-link,address")
+        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=fuzzer-no-link,address")
+        set(FUZZING_COMPILE_FLAGS "")
+        # Link against libfuzzer and adderss sanitizer.
+        set(FUZZING_LINK_FLAGS "-fsanitize=fuzzer,address")
+    endif()
+    add_subdirectory(fuzz)
+endif()

fuzz/CMakeLists.txt

@@ -0,0 +1,16 @@
+set(FUZZ_TARGETS 
+    hash_fuzzer
+    string_fuzzer
+)
+
+foreach(TARGET ${FUZZ_TARGETS})
+    add_executable("${TARGET}" "${TARGET}.cpp")
+    # Apply the determined flags
+    set_target_properties(${TARGET} PROPERTIES
+        COMPILE_FLAGS "${FUZZING_COMPILE_FLAGS}"
+        LINK_FLAGS "${FUZZING_LINK_FLAGS}"
+    )
+    # Link QuantLib and any other necessary libraries
+    target_link_libraries(${TARGET} PRIVATE etl::etl)
+    target_sources(${TARGET} PRIVATE etl_profile.h)
+endforeach()

fuzz/etl_profile.h

@@ -0,0 +1,138 @@
+///\file
+
+/******************************************************************************
+The MIT License(MIT)
+
+Embedded Template Library.
+https://github.com/ETLCPP/etl
+https://www.etlcpp.com
+
+Copyright(c) 2017 John Wellbelove
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files(the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions :
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+******************************************************************************/
+
+#ifndef ETL_PROFILE_H_INCLUDED
+#define ETL_PROFILE_H_INCLUDED
+
+#define ETL_THROW_EXCEPTIONS
+#define ETL_VERBOSE_ERRORS
+#define ETL_CHECK_PUSH_POP
+#define ETL_ISTRING_REPAIR_ENABLE
+#define ETL_IVECTOR_REPAIR_ENABLE
+#define ETL_IDEQUE_REPAIR_ENABLE
+#define ETL_ICIRCULAR_BUFFER_REPAIR_ENABLE
+#define ETL_IN_UNIT_TEST
+//#define ETL_DEBUG_COUNT
+#define ETL_ARRAY_VIEW_IS_MUTABLE
+
+#define ETL_MESSAGE_TIMER_USE_ATOMIC_LOCK
+#define ETL_CALLBACK_TIMER_USE_ATOMIC_LOCK
+
+#define ETL_POLYMORPHIC_RANDOM
+
+#define ETL_POLYMORPHIC_BITSET
+#define ETL_POLYMORPHIC_DEQUE
+#define ETL_POLYMORPHIC_FLAT_MAP
+#define ETL_POLYMORPHIC_FLAT_MULTIMAP
+#define ETL_POLYMORPHIC_FLAT_SET
+#define ETL_POLYMORPHIC_FLAT_MULTISET
+#define ETL_POLYMORPHIC_FORWARD_LIST
+#define ETL_POLYMORPHIC_LIST
+#define ETL_POLYMORPHIC_MAP
+#define ETL_POLYMORPHIC_MULTIMAP
+#define ETL_POLYMORPHIC_SET
+#define ETL_POLYMORPHIC_MULTISET
+#define ETL_POLYMORPHIC_QUEUE
+#define ETL_POLYMORPHIC_STACK
+#define ETL_POLYMORPHIC_REFERENCE_FLAT_MAP
+#define ETL_POLYMORPHIC_REFERENCE_FLAT_MULTIMAP
+#define ETL_POLYMORPHIC_REFERENCE_FLAT_SET
+#define ETL_POLYMORPHIC_REFERENCE_FLAT_MULTISET
+#define ETL_POLYMORPHIC_UNORDERED_MAP
+#define ETL_POLYMORPHIC_UNORDERED_MULTIMAP
+#define ETL_POLYMORPHIC_UNORDERED_SET
+#define ETL_POLYMORPHIC_UNORDERED_MULTISET
+#define ETL_POLYMORPHIC_STRINGS
+#define ETL_POLYMORPHIC_POOL
+#define ETL_POLYMORPHIC_VECTOR
+#define ETL_POLYMORPHIC_INDIRECT_VECTOR
+
+#if defined(ETL_FORCE_TEST_CPP03_IMPLEMENTATION)
+  #define ETL_FUNCTION_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_PRIORITY_QUEUE_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_QUEUE_ATOMIC_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_VARIANT_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_VECTOR_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_QUEUE_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_QUEUE_MPMC_MUTEX_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_QUEUE_ISR_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_QUEUE_LOCKED_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_OPTIONAL_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_LARGEST_TYPE_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_TYPE_SELECT_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_UNINITIALIZED_BUFFER_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_CRC_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_MEM_CAST_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_OBSERVER_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_MESSAGE_PACKET_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_OBSERVER_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_MESSAGE_ROUTER_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_FSM_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_DELEGATE_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_SINGLETON_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_BYTE_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_LIST_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_FORWARD_LIST_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_FLAT_SET_FORCE_CPP03_IMPLEMENTATION
+  #define ETL_FLAT_MULTISET_FORCE_CPP03_IMPLEMENTATION
+#endif
+
+#if defined(ETL_FORCE_TEST_CPP11)
+  #define ETL_OVERLOAD_FORCE_CPP11
+  #define ETL_VARIANT_FORCE_CPP11
+#endif
+
+#include "../include/etl/profiles/determine_compiler_language_support.h"
+#include "../include/etl/profiles/determine_compiler_version.h"
+#include "../include/etl/profiles/determine_development_os.h"
+
+//#if ETL_CPP17_NOT_SUPPORTED
+//  #error THE UNIT TESTS REQUIRE C++17 SUPPORT
+//#endif
+
+#if defined(ETL_COMPILER_GCC)
+  #if (ETL_COMPILER_VERSION < 8)
+    #define ETL_TEMPLATE_DEDUCTION_GUIDE_TESTS_DISABLED
+  #endif
+#endif
+
+#if defined(ETL_DEVELOPMENT_OS_WINDOWS)
+  #define ETL_TARGET_OS_WINDOWS
+#elif defined(ETL_DEVELOPMENT_OS_LINUX)
+  #define ETL_TARGET_OS_LINUX
+#else
+  #define ETL_TARGET_OS_GENERIC
+#endif
+
+#if !((ETL_CPP20_SUPPORTED && !defined(ETL_NO_STL)) || defined(__BYTE_ORDER__))
+  #define ETL_ENDIAN_NATIVE 0
+#endif
+
+#endif

fuzz/hash_fuzzer.cpp

@@ -0,0 +1,42 @@
+#include "etl/checksum.h"
+#include "etl/crc.h"
+#include <cstddef>
+#include <cstdint>
+#include <fuzzer/FuzzedDataProvider.h>
+#include <vector>
+#include <cassert>
+
+extern "C" int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size) {
+  FuzzedDataProvider fdp(data, size);
+  const size_t kMaxBufferSize = 1024;
+  // ---- Checksums ----
+  std::vector<uint8_t> buffer = fdp.ConsumeBytes<uint8_t>(
+      fdp.ConsumeIntegralInRange<size_t>(0, kMaxBufferSize));
+  uint8_t sum = etl::checksum<uint8_t>(buffer.begin(), buffer.end());
+
+  etl::checksum<uint8_t> checksum_calculator;
+
+  for (size_t i = 0UL; i < buffer.size(); ++i) {
+    checksum_calculator.add(buffer[i]);
+  }
+
+  uint8_t loop_sum = checksum_calculator;
+  assert(sum == loop_sum);
+
+  // ---- CRC ----
+  // Get new data for new algorithm.
+  buffer = fdp.ConsumeBytes<uint8_t>(
+      fdp.ConsumeIntegralInRange<size_t>(0, kMaxBufferSize));
+  
+  uint8_t crc = etl::crc8_ccitt(buffer.begin(), buffer.end());
+  etl::crc8_ccitt crc_calculator;
+  
+  for (size_t i = 0UL; i < buffer.size(); ++i) {
+    crc_calculator.add(buffer[i]);
+  }
+
+  uint8_t loop_crc = crc_calculator;
+  assert(crc == loop_crc);
+
+  return 0;
+}

fuzz/string_fuzzer.cpp

@@ -0,0 +1,59 @@
+#include "etl/string.h"
+#include "etl/to_arithmetic.h"
+#include <cassert>
+#include <cstddef>
+#include <cstdint>
+#include <fuzzer/FuzzedDataProvider.h>
+#include <string>
+
+template <typename T> void fuzzed_convert_integral(FuzzedDataProvider *fdp) {
+  assert(fdp != nullptr);
+  std::string s = fdp->ConsumeRandomLengthString();
+  etl::string_view etl_string(s.c_str(), s.size());
+
+  etl::radix::value_type radix = fdp->PickValueInArray({
+    etl::radix::binary,
+    etl::radix::octal,
+    etl::radix::decimal,
+    etl::radix::hex
+  });
+
+  auto result = etl::to_arithmetic<T, char>(etl_string, radix);
+  if (result.has_value()) {
+    volatile T value = result.value();
+    (void)value;
+  }
+}
+
+template <typename T> void fuzzed_convert_float(FuzzedDataProvider *fdp) {
+  assert(fdp != nullptr);
+  std::string s = fdp->ConsumeRandomLengthString();
+  etl::string_view etl_string(s.c_str(), s.size());
+
+  auto result = etl::to_arithmetic<T, char>(etl_string);
+  if (result.has_value()) {
+    volatile T value = result.value();
+    (void)value;
+  }
+}
+
+extern "C" int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size) {
+  FuzzedDataProvider fdp(data, size);
+  // Unsigned.
+  fuzzed_convert_integral<uint8_t>(&fdp);
+  fuzzed_convert_integral<uint16_t>(&fdp);
+  fuzzed_convert_integral<uint32_t>(&fdp);
+  fuzzed_convert_integral<uint64_t>(&fdp);
+
+  // Signed.
+  fuzzed_convert_integral<int8_t>(&fdp);
+  fuzzed_convert_integral<int16_t>(&fdp);
+  fuzzed_convert_integral<int32_t>(&fdp);
+  fuzzed_convert_integral<int64_t>(&fdp);
+
+  // Floating.
+  fuzzed_convert_float<float>(&fdp);
+  fuzzed_convert_float<double>(&fdp);
+  fuzzed_convert_float<long double>(&fdp);
+  return 0;
+}