Permalink
Fetching contributors…
Cannot retrieve contributors at this time
492 lines (428 sloc) 16.7 KB
# Copyright (c) 2014-present, Facebook, Inc.
# All rights reserved.
#
# This source code is licensed under both the Apache 2.0 license (found in the
# LICENSE file in the root directory of this source tree) and the GPLv2 (found
# in the COPYING file in the root directory of this source tree).
# You may select, at your option, one of the above-listed licenses.
cmake_policy(SET CMP0068 NEW)
# The 'core' source files define the osquery SDK (libosquery).
# There are macros throughout CMake to append sources to this list.
set(OSQUERY_SOURCES "")
# A separate list of library links (and linking options) is maintained for
# the 'core' set of sources.
set(OSQUERY_LINKS "")
# Finally a set of 'core' tests, and benchmark tests, is kept.
set(OSQUERY_TESTS "")
set(OSQUERY_BENCHMARKS "")
# The 'additional' source files are NOT included with SDK (libosquery_additional).
set(OSQUERY_ADDITIONAL_SOURCES "")
# Temporary hack for additional library, this library is sourceless
# so for some reason CMake adds "rm -f" as PostBuild step to XCode project
if(CMAKE_GENERATOR STREQUAL Xcode)
set(OSQUERY_ADDITIONAL_SOURCES main/empty.cpp)
endif()
set(OSQUERY_ADDITIONAL_LINKS "")
set(OSQUERY_ADDITIONAL_TESTS "")
set(OSQUERY_TABLES_TESTS "")
# Add all and extra for osquery code.
if(CLANG AND POSIX)
add_compile_options(
-Werror
-Wall
-Wextra
-pedantic
-Wuseless-cast
-Wno-c99-extensions
-Wno-zero-length-array
-Wno-unused-parameter
-Wno-gnu-case-range
-Weffc++
)
if(NOT FREEBSD)
add_compile_options(
-Wshadow-all
-Wno-shadow-field
)
endif()
endif()
if(DEFINED ENV{SANITIZE})
if(DEFINED ENV{SANITIZE_THREAD})
ADD_OSQUERY_LINK_CORE(-fsanitize=thread)
elseif(DEFINED ENV{SANITIZE_UNDEFINED})
ADD_OSQUERY_LINK_CORE(-fsanitize=undefined)
else()
ADD_OSQUERY_LINK_CORE(-fsanitize=address -fsanitize=leak)
endif()
ADD_OSQUERY_LINK_CORE(-fsanitize-blacklist=${SANITIZE_BLACKLIST})
if(DEFINED ENV{FUZZ})
ADD_OSQUERY_LINK_CORE(-fsanitize=fuzzer)
endif()
endif()
# Construct a set of all object files, starting with third-party and all
# of the osquery core objects (sources from ADD_CORE_LIBRARY macros).
if(FREEBSD)
set(OSQUERY_OBJECTS $<TARGET_OBJECTS:osquery_sqlite>)
else()
set(OSQUERY_OBJECTS
$<TARGET_OBJECTS:osquery_sqlite>
$<TARGET_OBJECTS:linenoise-ng>
)
endif()
#main library
add_library(libosquery STATIC main/lib.cpp)
# Add subdirectories
include(config/CMakeLists.txt)
include(core/CMakeLists.txt)
include(database/CMakeLists.txt)
include(debug/CMakeLists.txt)
include(devtools/CMakeLists.txt)
include(dispatcher/CMakeLists.txt)
include(distributed/CMakeLists.txt)
include(events/CMakeLists.txt)
include(extensions/CMakeLists.txt)
include(filesystem/CMakeLists.txt)
include(logger/CMakeLists.txt)
include(killswitch/CMakeLists.txt)
include(registry/CMakeLists.txt)
include(sql/CMakeLists.txt)
include(remote/CMakeLists.txt)
include(utils/CMakeLists.txt)
include(numeric_monitoring/CMakeLists.txt)
include(profiler/CMakeLists.txt)
if(NOT SKIP_CARVER)
include(carver/CMakeLists.txt)
endif()
# Add externals directory from parent
if(NOT DEFINED ENV{FUZZ})
add_subdirectory("${CMAKE_SOURCE_DIR}/external" "${CMAKE_BINARY_DIR}/external")
endif()
if(NOT SKIP_TABLES)
add_subdirectory(tables)
# Amalgamate the utility tables needed to compile.
GENERATE_UTILITIES("${CMAKE_SOURCE_DIR}")
AMALGAMATE("${CMAKE_SOURCE_DIR}" "utils" AMALGAMATION_UTILS)
ADD_OSQUERY_LIBRARY_CORE(osquery_amalgamation ${AMALGAMATION_UTILS})
endif()
target_group_sources(libosquery "${CMAKE_CURRENT_LIST_DIR}")
if(WINDOWS)
if(CMAKE_BUILD_TYPE EQUAL "DEBUG")
set(WB_KEY "sgd")
set(WO_KEY "_dbg")
set(WT_KEY "d_dbg")
else()
set(WB_KEY "s")
set(WO_KEY "")
endif()
ADD_OSQUERY_LINK_CORE("ntdll.lib")
ADD_OSQUERY_LINK_CORE("ws2_32.lib")
ADD_OSQUERY_LINK_CORE("iphlpapi.lib")
ADD_OSQUERY_LINK_CORE("netapi32.lib")
ADD_OSQUERY_LINK_CORE("rpcrt4.lib")
ADD_OSQUERY_LINK_CORE("shlwapi.lib")
ADD_OSQUERY_LINK_CORE("version.lib")
ADD_OSQUERY_LINK_CORE("Wtsapi32.lib")
ADD_OSQUERY_LINK_CORE("wbemuuid.lib")
ADD_OSQUERY_LINK_CORE("Secur32.lib")
ADD_OSQUERY_LINK_CORE("taskschd.lib")
ADD_OSQUERY_LINK_CORE("dbghelp.lib")
ADD_OSQUERY_LINK_CORE("dbgeng.lib")
ADD_OSQUERY_LINK_CORE("libboost_system-mt-${WB_KEY}")
ADD_OSQUERY_LINK_CORE("libboost_regex-mt-${WB_KEY}")
ADD_OSQUERY_LINK_CORE("libboost_filesystem-mt-${WB_KEY}")
ADD_OSQUERY_LINK_CORE("libboost_context-mt-${WB_KEY}")
ADD_OSQUERY_LINK_CORE("libboost_thread-mt-${WB_KEY}")
ADD_OSQUERY_LINK_CORE("rocksdb${WO_KEY}")
ADD_OSQUERY_LINK_CORE("thriftmt${WT_KEY}")
ADD_OSQUERY_LINK_CORE("gflags_static${WO_KEY}")
ADD_OSQUERY_LINK_CORE("ssleay32")
ADD_OSQUERY_LINK_CORE("eay32")
ADD_OSQUERY_LINK_CORE("zlibstatic")
# Enable control flow guard
ADD_OSQUERY_LINK_CORE("-guard:cf")
else()
ADD_OSQUERY_LINK_CORE("libpthread")
ADD_OSQUERY_LINK_CORE("libz")
ADD_OSQUERY_LINK_CORE("gflags")
ADD_OSQUERY_LINK_CORE("thrift")
endif()
if(APPLE OR LINUX)
ADD_OSQUERY_LINK_CORE("libdl")
ADD_OSQUERY_LINK_CORE("rocksdb_lite")
ADD_OSQUERY_LINK_ADDITIONAL("rocksdb_lite")
elseif(FREEBSD)
ADD_OSQUERY_LINK_CORE("icuuc")
ADD_OSQUERY_LINK_CORE("linenoise")
ADD_OSQUERY_LINK_CORE("rocksdb-lite")
ADD_OSQUERY_LINK_ADDITIONAL("rocksdb-lite")
endif()
if(POSIX)
ADD_OSQUERY_LINK_CORE("boost_system")
ADD_OSQUERY_LINK_CORE("boost_filesystem")
ADD_OSQUERY_LINK_CORE("boost_thread")
ADD_OSQUERY_LINK_CORE("boost_context")
ADD_OSQUERY_LINK_ADDITIONAL("boost_regex")
endif()
if(LINUX OR FREEBSD)
ADD_OSQUERY_LINK_CORE("librt")
ADD_OSQUERY_LINK_CORE("libc")
endif()
# Remaining additional development libraries.
ADD_OSQUERY_LINK_CORE("glog${WO_KEY}")
if(POSIX)
# Hashing methods in core use libcrypto.
ADD_OSQUERY_LINK_CORE("crypto")
ADD_OSQUERY_LINK_ADDITIONAL("ssl")
ADD_OSQUERY_LINK_ADDITIONAL("libpthread")
ADD_OSQUERY_LINK_ADDITIONAL("magic")
endif()
if(APPLE)
ADD_OSQUERY_LINK_CORE("liblzma libbz2")
else()
if(POSIX)
ADD_OSQUERY_LINK_CORE("lzma")
endif()
ADD_OSQUERY_LINK_CORE("bz2")
ADD_OSQUERY_LINK_ADDITIONAL("bz2")
endif()
# The platform-specific SDK + core linker flags.
if(POSIX)
ADD_OSQUERY_LINK_CORE("-rdynamic")
endif()
if(APPLE)
ADD_OSQUERY_LINK_CORE("-Wl,-dead_strip")
ADD_OSQUERY_LINK_CORE("-mmacosx-version-min=${OSX_VERSION_MIN}")
ADD_OSQUERY_LINK_CORE("-Wl,-cache_path_lto,${CMAKE_BINARY_DIR}/ltocache")
ADD_OSQUERY_LINK_CORE("-Wl,-no_weak_imports")
elseif(LINUX OR FREEBSD)
ADD_OSQUERY_LINK_CORE("-Wl,-zrelro -Wl,-znow")
if(NOT DEFINED ENV{SANITIZE} AND (CMAKE_BUILD_TYPE STREQUAL "RELEASE"))
ADD_OSQUERY_LINK_CORE("-pie")
endif()
endif()
if(LINUX)
ADD_OSQUERY_LINK_ADDITIONAL("uuid")
if(NOT DEFINED ENV{OSQUERY_BUILD_LINK_SHARED})
ADD_OSQUERY_LINK_CORE("-static-libstdc++")
ADD_OSQUERY_LINK_ADDITIONAL("-static-libstdc++")
endif()
# For Ubuntu/CentOS packages add the build SHA1.
ADD_OSQUERY_LINK_CORE("-Wl,--build-id")
if (CLANG AND DEPS)
# If using GCC, libgcc_s may be needed.
ADD_OSQUERY_LINK_CORE("-fuse-ld=lld")
ADD_OSQUERY_LINK_CORE("c++")
ADD_OSQUERY_LINK_CORE("c++abi")
ADD_OSQUERY_LINK_CORE("unwind")
if(NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS 5.0.0)
ADD_OSQUERY_LINK_CORE("-Wl,--thinlto-cache-dir=${CMAKE_BINARY_DIR}/cache")
ADD_OSQUERY_LINK_CORE("-Wl,--thinlto-cache-policy,cache_size_bytes=2g")
endif()
ADD_OSQUERY_LINK_CORE("-B${BUILD_DEPS}/legacy/lib")
endif()
endif()
# Bubble the subdirectory (component) sources and links for this build.
list(APPEND OSQUERY_OBJECTS ${OSQUERY_SOURCES})
list(APPEND OSQUERY_LIBS ${OSQUERY_LINKS})
set(CMAKE_MACOSX_RPATH 0)
set(CMAKE_SKIP_RPATH TRUE)
# A final map from CMake build platform to a enum using for runtime detection.
# The goal is to provide a minimum set of compile code paths.
# See ./include/core.h for the enum class.
# POSIX = 0x01
# WINDOWS = 0x02
# BSD = 0x04
# LINUX = 0x08 && POSIX
# OS X = 0x10 && BSD && POSIX
# FREEBSD = 0x20 && BSD && POSIX
if(WINDOWS)
math(EXPR PLATFORM_MASK "2")
elseif(LINUX)
math(EXPR PLATFORM_MASK "1 + 8")
elseif(APPLE)
math(EXPR PLATFORM_MASK "1 + 4 + 16")
elseif(FREEBSD)
math(EXPR PLATFORM_MASK "1 + 4 + 32")
endif()
# Create the static libosquery (everything but non-utility tables).
set(OSQUERY_LIBRARY_FLAGS
-DOSQUERY_BUILD_VERSION=${OSQUERY_BUILD_VERSION}
-DOSQUERY_PLATFORM_MASK=${PLATFORM_MASK}
)
JOIN("${OSQUERY_LIBRARY_FLAGS}" " " OSQUERY_LIBRARY_FLAGS)
target_sources(libosquery PRIVATE ${OSQUERY_OBJECTS})
target_link_libraries(libosquery ${OSQUERY_LIBS})
set_target_properties(libosquery PROPERTIES OUTPUT_NAME osquery)
set_target_properties(libosquery PROPERTIES COMPILE_FLAGS "${OSQUERY_LIBRARY_FLAGS}")
# Create the dynamic libosquery.
if(DEFINED ENV{OSQUERY_BUILD_SHARED})
add_library(a_shared SHARED main/lib.cpp ${OSQUERY_OBJECTS})
target_link_libraries(libosquery_shared PRIVATE ${OSQUERY_LIBS})
set_target_properties(libosquery_shared PROPERTIES COMPILE_FLAGS "${OSQUERY_LIBRARY_FLAGS}")
set_target_properties(libosquery_shared PROPERTIES OUTPUT_NAME osquery)
endif()
# A friendly echo printed after the library is built.
add_custom_target(osquery_library ALL
COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan --bold
"-- Built libosquery: $<TARGET_FILE:libosquery>"
DEPENDS libosquery
)
# make devel (implies install)
add_custom_target(devel
COMMAND ${CMAKE_COMMAND} -D COMPONENT=devel -P cmake_install.cmake
DEPENDS libosquery_basic
)
add_dependencies(devel libosquery)
if(NOT OSQUERY_BUILD_SDK_ONLY)
if(NOT SKIP_TABLES)
# Generate the osquery additional tables (the non-util).
GENERATE_TABLES("${CMAKE_SOURCE_DIR}")
AMALGAMATE("${CMAKE_SOURCE_DIR}" "additional" AMALGAMATION)
ADD_OSQUERY_LIBRARY_ADDITIONAL(osquery_additional_amalgamation ${AMALGAMATION})
AMALGAMATE("${CMAKE_SOURCE_DIR}" "foreign" AMALGAMATION_FOREIGN)
ADD_OSQUERY_LIBRARY_ADDITIONAL(osquery_foreign_amalgamation ${AMALGAMATION_FOREIGN})
endif()
# Create the static libosquery_additional.
add_library(libosquery_additional STATIC ${OSQUERY_ADDITIONAL_SOURCES})
target_link_libraries(libosquery_additional ${OSQUERY_ADDITIONAL_LINKS})
set_target_properties(libosquery_additional PROPERTIES OUTPUT_NAME osquery_additional)
endif()
if(FUZZ)
add_executable(fuzz
main/fuzz.cpp
)
ADD_DEFAULT_LINKS(fuzz TRUE)
SET_OSQUERY_COMPILE(fuzz)
set_target_properties(fuzz PROPERTIES OUTPUT_NAME osqueryf)
endif()
if(NOT OSQUERY_BUILD_SDK_ONLY AND NOT FUZZ)
# Create the dynamic libosquery_additional.
if(DEFINED ENV{OSQUERY_BUILD_SHARED})
add_library(libosquery_additional_shared SHARED ${OSQUERY_ADDITIONAL_SOURCES})
target_link_libraries(libosquery_additional_shared PRIVATE ${OSQUERY_LINKS} ${OSQUERY_ADDITIONAL_LINKS})
set_target_properties(libosquery_additional_shared PROPERTIES OUTPUT_NAME osquery_additional)
endif()
set(DAEMON_SOURCE_FILES
devtools/shell.cpp
main/main.cpp
main/${PROCESS_FAMILY}/main.cpp
)
# Add the versioning information for Windows binaries
if(WINDOWS)
# The windows version resource requires a version string, as well
# as version components separated by a comma. First we replace the `-`
# values that may exist for commit hash versions, then we grab the
# major version components
string(REPLACE "-" "." OSQUERY_VER_TEMP "${OSQUERY_BUILD_VERSION}")
string(REPLACE "." ";" OSQUERY_VERSION_LIST "${OSQUERY_VER_TEMP}")
list(GET OSQUERY_VERSION_LIST 0 OSQUERY_PRODUCT_NUMBER)
list(GET OSQUERY_VERSION_LIST 1 OSQUERY_PRODUCT_VERSION)
list(GET OSQUERY_VERSION_LIST 2 OSQUERY_BUILD_NUMBER)
configure_file(
${CMAKE_SOURCE_DIR}/tools/windows_resources.rc.in
${CMAKE_BINARY_DIR}/osquery/windows_resources.rc
@ONLY)
list(APPEND DAEMON_SOURCE_FILES ${CMAKE_BINARY_DIR}/osquery/windows_resources.rc)
endif()
add_executable(daemon
${DAEMON_SOURCE_FILES}
)
ADD_DEFAULT_LINKS(daemon TRUE)
SET_OSQUERY_COMPILE(daemon)
set_target_properties(daemon PROPERTIES OUTPUT_NAME osqueryd)
# A friendly echo printed before building the daemon
add_custom_command(TARGET daemon PRE_BUILD
COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan --bold
"-- Building osqueryd: $<TARGET_FILE:daemon>"
)
set(SHELL_EXECUTABLE "osqueryi")
if(WINDOWS)
set(SHELL_EXECUTABLE "${SHELL_EXECUTABLE}.exe")
endif()
add_custom_target(shell ALL
COMMAND ${CMAKE_COMMAND} -E copy
$<TARGET_FILE:daemon> "$<TARGET_FILE_DIR:daemon>/${SHELL_EXECUTABLE}")
add_custom_command(
TARGET shell POST_BUILD
COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan --bold
"-- Creating osqueryi: $<TARGET_FILE_DIR:daemon>/${SHELL_EXECUTABLE}")
# This is no longer supported.
# Include the public API includes if make devel.
# install(TARGETS libosquery ARCHIVE DESTINATION lib COMPONENT devel OPTIONAL)
# install(DIRECTORY "${CMAKE_SOURCE_DIR}/include/osquery"
# DESTINATION include
# COMPONENT devel OPTIONAL
# PATTERN ".*" EXCLUDE
# )
# make install (executables)
install(TARGETS daemon RUNTIME DESTINATION bin COMPONENT main)
install(PROGRAMS ${CMAKE_BINARY_DIR}/osquery/osqueryi DESTINATION bin COMPONENT main)
install(FILES "${CMAKE_SOURCE_DIR}/tools/deployment/osqueryctl"
DESTINATION bin COMPONENT main)
# make install (config files)
install(FILES "${CMAKE_SOURCE_DIR}/tools/deployment/osquery.example.conf"
DESTINATION "${CMAKE_INSTALL_PREFIX}/share/osquery/" COMPONENT main)
install(DIRECTORY DESTINATION "${CMAKE_INSTALL_PREFIX}/var/osquery")
install(DIRECTORY "${CMAKE_SOURCE_DIR}/packs/"
DESTINATION "${CMAKE_INSTALL_PREFIX}/share/osquery/packs" COMPONENT main)
if(APPLE)
install(FILES "${CMAKE_SOURCE_DIR}/tools/deployment/com.facebook.osqueryd.plist"
DESTINATION "${CMAKE_INSTALL_PREFIX}/share/osquery/" COMPONENT main)
else()
install(PROGRAMS "${CMAKE_SOURCE_DIR}/tools/deployment/osqueryd.initd"
DESTINATION "${CMAKE_INSTALL_PREFIX}/etc/init.d/" RENAME "osqueryd" COMPONENT main)
endif()
endif()
if(NOT SKIP_TESTS)
# osquery testing library (testing helper methods/libs).
add_library(libosquery_testing STATIC tests/test_util.cpp)
add_dependencies(libosquery_testing libosquery)
SET_OSQUERY_COMPILE(libosquery_testing)
set_target_properties(libosquery_testing PROPERTIES OUTPUT_NAME osquery_testing)
# osquery core set of unit tests build with SDK.
add_executable(osquery_tests main/tests.cpp ${OSQUERY_TESTS})
ADD_DEFAULT_LINKS(osquery_tests FALSE)
target_link_libraries(osquery_tests gtest gmock libosquery_testing)
SET_OSQUERY_COMPILE(osquery_tests "${GTEST_FLAGS}")
add_test(osquery_tests osquery_tests ${TEST_ARGS})
# osquery benchmarks.
if(NOT SKIP_BENCHMARKS AND NOT OSQUERY_BUILD_SDK_ONLY)
add_executable(osquery_benchmarks main/benchmarks.cpp ${OSQUERY_BENCHMARKS})
target_link_libraries(osquery_benchmarks benchmark libosquery_testing pthread)
ADD_DEFAULT_LINKS(osquery_benchmarks TRUE)
SET_OSQUERY_COMPILE(osquery_benchmarks "${GTEST_FLAGS}")
set(BENCHMARK_TARGET "$<TARGET_FILE:osquery_benchmarks>")
# make benchmark
add_custom_target(
run-benchmark
COMMAND bash -c "${BENCHMARK_TARGET} $ENV{BENCHMARK_TO_FILE}"
WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
DEPENDS osquery_benchmarks
)
endif()
if(NOT OSQUERY_BUILD_SDK_ONLY)
# osquery core (additional) set of unit tests built outside of SDK.
add_executable(osquery_additional_tests tests/test_additional_util.cpp main/tests.cpp ${OSQUERY_ADDITIONAL_TESTS})
ADD_DEFAULT_LINKS(osquery_additional_tests TRUE)
target_link_libraries(osquery_additional_tests gtest gmock libosquery_testing)
SET_OSQUERY_COMPILE(osquery_additional_tests "${GTEST_FLAGS}")
add_test(osquery_additional_tests osquery_additional_tests ${TEST_ARGS})
# osquery tables set of unit tests (extracted for organization).
add_executable(osquery_tables_tests tests/test_additional_util.cpp main/tests.cpp ${OSQUERY_TABLES_TESTS})
ADD_DEFAULT_LINKS(osquery_tables_tests TRUE)
target_link_libraries(osquery_tables_tests gtest gmock libosquery_testing)
SET_OSQUERY_COMPILE(osquery_tables_tests "${GTEST_FLAGS}")
add_test(osquery_tables_tests osquery_tables_tests ${TEST_ARGS})
include(tests/integration/CMakeLists.txt)
add_executable(osquery_integration_tests main/tests.cpp $<TARGET_OBJECTS:osquery_tables_integration_tests>)
ADD_DEFAULT_LINKS(osquery_integration_tests TRUE)
target_link_libraries(osquery_integration_tests gtest gmock libosquery_testing)
SET_OSQUERY_COMPILE(osquery_integration_tests "${GTEST_FLAGS}")
add_test(NAME
osquery_integration_tests
COMMAND
osquery_tables_tests ${TEST_ARGS})
endif()
# Build the example extension with the SDK.
ADD_OSQUERY_EXTENSION(example_extension examples/example_extension.cpp)
endif()