Skip to content

Commit

Permalink
Google OSS-Fuzz integration (#411)
Browse files Browse the repository at this point in the history
  • Loading branch information
vy authored Sep 26, 2024
1 parent bc29a39 commit 1370eee
Show file tree
Hide file tree
Showing 13 changed files with 444 additions and 4 deletions.
13 changes: 12 additions & 1 deletion .github/workflows/log4cxx-ubuntu.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ jobs:
odbc: OFF
multithread: OFF
exitevents: OFF
fuzzers: OFF
- name: ubuntu20-clang
os: ubuntu-20.04
cxx: clang++
Expand All @@ -42,6 +43,7 @@ jobs:
odbc: ON
multithread: OFF
exitevents: OFF
fuzzers: ON
- name: ubuntu22-gcc
os: ubuntu-22.04
cxx: g++
Expand All @@ -50,6 +52,7 @@ jobs:
odbc: OFF
multithread: ON
exitevents: ON
fuzzers: OFF
- name: ubuntu22-clang
os: ubuntu-22.04
cxx: clang++
Expand All @@ -58,6 +61,7 @@ jobs:
odbc: OFF
multithread: ON
exitevents: OFF
fuzzers: ON

steps:
- uses: actions/checkout@v4
Expand Down Expand Up @@ -87,7 +91,14 @@ jobs:
cd main
mkdir build
cd build
cmake -DCMAKE_CXX_COMPILER=${{ matrix.cxx }} -DLOG4CXX_ENABLE_ODBC=${{ matrix.odbc }} -DLOG4CXX_QT_SUPPORT=${{ matrix.qt }} -DENABLE_MULTITHREAD_TEST=${{ matrix.multithread }} -DLOG4CXX_EVENTS_AT_EXIT=${{ matrix.exitevents }} ..
cmake \
-DCMAKE_CXX_COMPILER=${{ matrix.cxx }} \
-DLOG4CXX_ENABLE_ODBC=${{ matrix.odbc }} \
-DLOG4CXX_QT_SUPPORT=${{ matrix.qt }} \
-DENABLE_MULTITHREAD_TEST=${{ matrix.multithread }} \
-DLOG4CXX_EVENTS_AT_EXIT=${{ matrix.exitevents }} \
-DBUILD_FUZZERS=${{ matrix.fuzzers }} \
..
cmake --build .
- name: run unit tests
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ pom.xml.releaseBackup
release.properties

autom4te.cache/
.idea/
.vs/
out/
src/**/__history/
Expand Down
8 changes: 6 additions & 2 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ find_package(APR-Util REQUIRED)

find_package( Threads REQUIRED )

# Find LibFuzzer
include("${CMAKE_CURRENT_LIST_DIR}/src/cmake/FindLibFuzzer.cmake")

# Find expat for XML parsing
find_package(EXPAT REQUIRED)
if(TARGET EXPAT::EXPAT)
Expand Down Expand Up @@ -144,7 +147,7 @@ install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/src/main/include/log4cxx
)

install(TARGETS log4cxx EXPORT ${LOG4CXX_LIB_NAME}Targets
RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
Expand Down Expand Up @@ -180,7 +183,7 @@ configure_file("${CMAKE_CURRENT_SOURCE_DIR}/liblog4cxx.pc.in"
"${CMAKE_CURRENT_BINARY_DIR}/lib${LOG4CXX_LIB_NAME}.pc"
)

install(FILES "${CMAKE_CURRENT_BINARY_DIR}/lib${LOG4CXX_LIB_NAME}.pc"
install(FILES "${CMAKE_CURRENT_BINARY_DIR}/lib${LOG4CXX_LIB_NAME}.pc"
DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig)

if(LOG4CXX_QT_SUPPORT)
Expand Down Expand Up @@ -299,6 +302,7 @@ message(STATUS " C++ features requested: ......... : ${CMAKE_CXX_STANDARD}")
message(STATUS " Build shared library ............ : ${BUILD_SHARED_LIBS}")
message(STATUS " Build tests ..................... : ${BUILD_TESTING}")
message(STATUS " Build examples................... : ${BUILD_EXAMPLES}")
message(STATUS " Build fuzzers.................... : ${BUILD_FUZZERS}")
message(STATUS " Build site ...................... : ${BUILD_SITE}")
message(STATUS " Install prefix .................. : ${CMAKE_INSTALL_PREFIX}")
message(STATUS " log4cxx library name ............ : ${LOG4CXX_LIB_NAME}")
Expand Down
17 changes: 17 additions & 0 deletions src/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,21 @@ if(BUILD_EXAMPLES)
add_subdirectory(examples/cpp)
endif()

# Define `BUILD_FUZZERS_DEFAULT`
if(BUILD_TESTING AND LIBFUZZER_FOUND)
set(BUILD_FUZZERS_DEFAULT ON)
else()
set(BUILD_FUZZERS_DEFAULT OFF)
endif()

# Define `BUILD_FUZZERS`
option(BUILD_FUZZERS "Build log4cxx fuzzers" ${BUILD_FUZZERS_DEFAULT})
if(BUILD_FUZZERS)
if(NOT LIBFUZZER_FOUND)
message(SEND_ERROR "libfuzzer, required by the requested fuzzer build, is not found")
else()
add_subdirectory(fuzzers/cpp)
endif()
endif()

add_subdirectory(site)
29 changes: 29 additions & 0 deletions src/cmake/FindLibFuzzer.cmake
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

# This module sets `LIBFUZZER_FOUND` to `1` if libFuzzer[1] is found.
#
# [1] https://llvm.org/docs/LibFuzzer.html

if(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
try_compile(LIBFUZZER_FOUND
"${CMAKE_BINARY_DIR}/LibFuzzerTest"
"${CMAKE_CURRENT_LIST_DIR}/LibFuzzerTest.cpp"
CMAKE_FLAGS -DCOMPILE_DEFINITIONS=-fsanitize=fuzzer)
else()
set(LIBFUZZER_FOUND 0)
endif()
24 changes: 24 additions & 0 deletions src/cmake/LibFuzzerTest.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

#include <fuzzer/FuzzedDataProvider.h>

extern "C" int LLVMFuzzerTestOneInput(const uint8_t *data, const size_t size) {
FuzzedDataProvider dataProvider(data, size);
dataProvider.ConsumeBool();
return 0;
}
53 changes: 53 additions & 0 deletions src/fuzzers/bash/oss-fuzz-build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
#!/bin/bash -eu
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

# Read command line arguments
if [[ "$#" -ne 1 ]]; then
cat >&2 <<EOF
Generates fuzzer runner scripts to be employed by Google OSS-Fuzz.
For details, see: http://logging.apache.org/log4cxx/fuzzing.html
Usage: $0 <outputDir>
outputDir
The output directory to dump runner scripts and their dependencies.
EOF
exit 1
fi
outputDir=$(readlink -f "$1")

# Ensure output directory exists
mkdir -p "$outputDir"

# Switch to the project directory (by referencing from the script directory)
cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && cd ../../..

# Build the project
mkdir -p build && cd $_
cmake \
-DBUILD_SHARED_LIBS=OFF \
-DBUILD_TESTING=OFF \
-DBUILD_EXAMPLES=OFF \
-DBUILD_FUZZERS=ON \
..
cmake --build . -j

# Copy executables & resources
find src/fuzzers/cpp -maxdepth 1 -executable -type f -exec cp -v {} "$outputDir/" \;
cp -v ../src/fuzzers/resources/* "$outputDir/"
70 changes: 70 additions & 0 deletions src/fuzzers/cpp/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

set(ALL_LOG4CXX_FUZZERS PatternLayoutFuzzer)

# Get the most recent Git commit ID
execute_process(
COMMAND git rev-parse HEAD
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
OUTPUT_VARIABLE GIT_COMMIT_ID
OUTPUT_STRIP_TRAILING_WHITESPACE)

set(FUZZER_SANITIZE_FLAGS "-fsanitize=fuzzer,address,signed-integer-overflow")
set(FUZZER_COMPILE_DEFINITIONS "-DCOMPILE_DEFINITIONS=${FUZZER_SANITIZE_FLAGS}" "-DGIT_COMMIT_ID=\"${GIT_COMMIT_ID}\"")

if(WIN32)
include(win32_target_environment_path)
get_target_environment_path(ESCAPED_PATH)
elseif(CMAKE_BUILD_TYPE)
string(TOUPPER ${CMAKE_BUILD_TYPE} UPPER_BUILD_TYPE)
if (UPPER_BUILD_TYPE STREQUAL "DEBUG")
list(APPEND FUZZER_COMPILE_DEFINITIONS _DEBUG)
endif()
else()
list(APPEND FUZZER_COMPILE_DEFINITIONS _DEBUG)
endif()

foreach(fuzzerName IN LISTS ALL_LOG4CXX_FUZZERS)
set(PROGRAM_NAME "${fuzzerName}")
add_executable(${PROGRAM_NAME} ${fuzzerName}.cpp)
target_compile_definitions(${PROGRAM_NAME}
PRIVATE
${FUZZER_COMPILE_DEFINITIONS}
${LOG4CXX_COMPILE_DEFINITIONS}
${APR_COMPILE_DEFINITIONS}
${APR_UTIL_COMPILE_DEFINITIONS})
target_include_directories(${PROGRAM_NAME}
PRIVATE
${CMAKE_CURRENT_LIST_DIR}
$<TARGET_PROPERTY:log4cxx,INCLUDE_DIRECTORIES>)
target_link_libraries(${PROGRAM_NAME}
PRIVATE
${FUZZER_SANITIZE_FLAGS}
log4cxx
${APR_UTIL_LIBRARIES}
${EXPAT_LIBRARIES}
${APR_LIBRARIES}
${APR_SYSTEM_LIBS})
if(WIN32)
set_target_properties(${PROGRAM_NAME}
PROPERTIES
VS_DEBUGGER_ENVIRONMENT "PATH=${ESCAPED_PATH}"
VS_DEBUGGER_WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}
FOLDER Fuzzers)
endif()
endforeach()
Loading

0 comments on commit 1370eee

Please sign in to comment.