blob: 28fbe0ff60f423b9932d42369d3c6df67e093b6b [file] [log] [blame]
Ed Tanous1e439872018-05-18 11:48:52 -07001cmake_minimum_required (VERSION 3.5 FATAL_ERROR)
Ed Tanous0fdddb12017-02-28 11:06:34 -08002
Ed Tanous1e439872018-05-18 11:48:52 -07003cmake_policy (SET CMP0054 NEW)
Ed Tanouscfbe25d2017-05-23 16:34:35 -07004
Ed Tanous1e439872018-05-18 11:48:52 -07005set (CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake ${CMAKE_MODULE_PATH})
Ed Tanous0fdddb12017-02-28 11:06:34 -08006
Ed Tanous1e439872018-05-18 11:48:52 -07007option (BUILD_STATIC_LIBS "Built static libraries" ON)
Ed Tanous911ac312017-08-15 09:37:42 -07008
Joseph Reynolds7a777f52018-11-07 22:01:31 -06009option (YOCTO_DEPENDENCIES "Use YOCTO dependencies system" OFF)
Ed Tanous0fdddb12017-02-28 11:06:34 -080010
Joseph Reynolds7a777f52018-11-07 22:01:31 -060011option (BMCWEB_ENABLE_KVM "Enable the KVM host video WebSocket. Path is
Ed Tanous3eb2f352018-12-20 12:30:45 -080012 '/kvm/0'. Video is from the BMC's '/dev/video' device." ON)
Joseph Reynolds7a777f52018-11-07 22:01:31 -060013option (BMCWEB_ENABLE_DBUS_REST "Enable Phosphor REST (D-Bus) APIs. Paths
14 directly map Phosphor D-Bus object paths, for example,
15 '/xyz/openbmc_project/logging/entry/enumerate'. See
16 https://github.com/openbmc/docs/blob/master/rest-api.md." ON)
17option (BMCWEB_ENABLE_REDFISH "Enable Redfish APIs. Paths are under
18 '/redfish/v1/'. See
19 https://github.com/openbmc/bmcweb/blob/master/DEVELOPING.md#redfish."
20 ON)
21option (BMCWEB_ENABLE_HOST_SERIAL_WEBSOCKET "Enable host serial console
22 WebSocket. Path is '/console0'. See
23 https://github.com/openbmc/docs/blob/master/console.md." ON)
24option (BMCWEB_ENABLE_STATIC_HOSTING "Enable serving files from the
25 '/usr/share/www' directory as paths under '/'." ON)
26option (BMCWEB_ENABLE_REDFISH_BMC_JOURNAL "Enable BMC journal access through
27 Redfish. Paths are under
28 '/redfish/v1/Managers/bmc/LogServices/Journal'." OFF)
29option (BMCWEB_ENABLE_REDFISH_RAW_PECI "Enable PECI transactions through
Jason M. Billsd53dd412019-02-12 17:16:22 -080030 Redfish. Paths are under '/redfish/v1/Systems/system/LogServices/CpuLog/
Joseph Reynolds7a777f52018-11-07 22:01:31 -060031 Actions/Oem/CpuLog.SendRawPeci'." OFF)
32option (BMCWEB_ENABLE_REDFISH_CPU_LOG "Enable CPU log service transactions
33 through Redfish. Paths are under
Jason M. Billsd53dd412019-02-12 17:16:22 -080034 '/redfish/v1/Systems/system/LogServices/CpuLog'." OFF)
Gunnar Mills603a6642019-01-21 17:03:51 -060035option (BMCWEB_ENABLE_REDFISH_ONE_CHASSIS "Enable Redfish to assume only one
36 chassis is present. All sensors will be assumed to be under this
37 chassis. The chassis path is '/redfish/v1/Chassis/chassis'." OFF)
Andrew Geisslercb92c032018-08-17 07:56:14 -070038option (BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES "Enable DBUS log service
39 transactions through Redfish. Paths are under
40 '/redfish/v1/Systems/system/LogServices/EventLog/Entries'." OFF)
Ed Tanous1da66f72018-07-27 16:13:37 -070041
Ed Tanousbdd1c832018-10-12 11:00:30 -070042# Insecure options. Every option that starts with a BMCWEB_INSECURE flag should
Ed Tanous1e439872018-05-18 11:48:52 -070043# not be enabled by default for any platform, unless the author fully
44# comprehends the implications of doing so. In general, enabling these options
45# will cause security problems of varying degrees
Ed Tanousf0d73c22018-07-26 14:24:20 -070046option (BMCWEB_INSECURE_DISABLE_CSRF_PREVENTION "Disable CSRF prevention checks.
47 Should be set to OFF for production systems." OFF)
Ed Tanousf3d847c2017-06-12 16:01:42 -070048
Ed Tanousf0d73c22018-07-26 14:24:20 -070049option (BMCWEB_INSECURE_DISABLE_SSL "Disable SSL ports. Should be set to OFF for
50 production systems." OFF)
Ed Tanous0fdddb12017-02-28 11:06:34 -080051
Ed Tanousf0d73c22018-07-26 14:24:20 -070052option (BMCWEB_INSECURE_DISABLE_AUTHENTICATION "Disable authentication on all
53 ports. Should be set to OFF for production systems" OFF)
Ed Tanous0fdddb12017-02-28 11:06:34 -080054
Ed Tanous1e439872018-05-18 11:48:52 -070055option (BMCWEB_INSECURE_DISABLE_XSS_PREVENTION "Disable XSS preventions" OFF)
Ed Tanous0d485ef2017-05-23 09:23:53 -070056
Ed Tanous1e439872018-05-18 11:48:52 -070057project (bmc-webserver CXX)
58
59include (CTest)
60
Ed Tanous62288742018-10-16 14:58:20 -070061set (CMAKE_CXX_STANDARD 17)
Ed Tanous1e439872018-05-18 11:48:52 -070062set (CMAKE_CXX_STANDARD_REQUIRED ON)
63
64set (CMAKE_EXPORT_COMPILE_COMMANDS ON)
65
Ed Tanousb01bf292019-03-25 19:25:26 +000066set (CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS} -Wall")
Ed Tanous1e439872018-05-18 11:48:52 -070067
68set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-rtti")
69set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fno-rtti")
Ed Tanous3dac7492017-08-02 13:46:20 -070070
Ed Tanous0fdddb12017-02-28 11:06:34 -080071# general
Ed Tanous797d0c02018-08-07 10:22:35 -070072option (BMCWEB_BUILD_UT "Enable Unit test" OFF)
Ed Tanous8041f312017-04-03 09:47:01 -070073
Ed Tanous1ccd57c2017-03-21 13:15:58 -070074# security flags
Ed Tanousf0d73c22018-07-26 14:24:20 -070075set (SECURITY_FLAGS "\
Ed Tanous580f3722018-03-13 16:59:02 -070076 -fstack-protector-strong \
77 -fPIE \
78 -fPIC \
79 -D_FORTIFY_SOURCE=2 \
80 -Wformat \
Ed Tanousf0d73c22018-07-26 14:24:20 -070081 -Wformat-security")
Ed Tanous1e439872018-05-18 11:48:52 -070082set (CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} ${SECURITY_FLAGS}")
Ed Tanousf0d73c22018-07-26 14:24:20 -070083set (
84 CMAKE_CXX_FLAGS_RELWITHDEBINFO
85 "${CMAKE_CXX_FLAGS_RELWITHDEBINFO} ${SECURITY_FLAGS}"
86)
Ed Tanous1e439872018-05-18 11:48:52 -070087set (CMAKE_C_FLAGS_MINSIZEREL "${CMAKE_C_FLAGS_MINSIZEREL} ${SECURITY_FLAGS}")
Ed Tanous3dac7492017-08-02 13:46:20 -070088
Ed Tanous580f3722018-03-13 16:59:02 -070089# Enable link time optimization This is a temporary workaround because
90# INTERPROCEDURAL_OPTIMIZATION isn't available until cmake 3.9. gcc-ar and gcc-
91# ranlib are wrappers around ar and ranlib which add the lto plugin to the
92# command line.
Ed Tanous1e439872018-05-18 11:48:52 -070093if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
94 if (NOT CMAKE_BUILD_TYPE MATCHES Debug)
95 string (REGEX REPLACE "ar$" "gcc-ar" CMAKE_AR ${CMAKE_AR})
Ed Tanousf0d73c22018-07-26 14:24:20 -070096 string (
97 REGEX
98 REPLACE "ranlib$" "gcc-ranlib" CMAKE_RANLIB ${CMAKE_RANLIB}
99 )
Ed Tanous1e439872018-05-18 11:48:52 -0700100 set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -flto -fno-fat-lto-objects")
Borawski.Lukasz109799e2018-01-30 15:04:42 +0100101
Ed Tanous1e439872018-05-18 11:48:52 -0700102 # Reduce the binary size by removing unnecessary dynamic symbol table
103 # entries
Ed Tanousf0d73c22018-07-26 14:24:20 -0700104 set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} \
Ed Tanous580f3722018-03-13 16:59:02 -0700105 -fvisibility=hidden \
106 -fvisibility-inlines-hidden \
Ed Tanousf0d73c22018-07-26 14:24:20 -0700107 -Wl,--exclude-libs,ALL")
Ed Tanous1e439872018-05-18 11:48:52 -0700108 endif (NOT CMAKE_BUILD_TYPE MATCHES Debug)
109endif ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
Borawski.Lukasz109799e2018-01-30 15:04:42 +0100110
Ed Tanous1e439872018-05-18 11:48:52 -0700111if (NOT ${YOCTO_DEPENDENCIES}) # Download and unpack googletest at configure
112 # time
113 configure_file (CMakeLists.txt.in 3rdparty/CMakeLists.txt)
Ed Tanousf0d73c22018-07-26 14:24:20 -0700114 execute_process (
115 COMMAND ${CMAKE_COMMAND} -G "${CMAKE_GENERATOR}" .
116 WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/3rdparty
117 )
118 execute_process (
119 COMMAND ${CMAKE_COMMAND} --build .
120 WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/3rdparty
121 )
Ed tanous7d95f5f2018-03-23 00:19:20 -0700122
Ed Tanous1e439872018-05-18 11:48:52 -0700123 set (CMAKE_PREFIX_PATH ${CMAKE_BINARY_DIR}/prefix ${CMAKE_PREFIX_PATH})
124endif ()
Ed tanous7d95f5f2018-03-23 00:19:20 -0700125
Ed Tanous580f3722018-03-13 16:59:02 -0700126# add_definitions(-DBOOST_ASIO_ENABLE_HANDLER_TRACKING)
Ed Tanousd3a38062018-07-27 12:06:29 -0700127add_definitions (-DBOOST_ASIO_DISABLE_THREADS)
Ed Tanous39e77502019-03-04 17:35:53 -0800128add_definitions (-DBOOST_BEAST_USE_STD_STRING_VIEW)
Ed Tanous1e439872018-05-18 11:48:52 -0700129add_definitions (-DBOOST_ERROR_CODE_HEADER_ONLY)
130add_definitions (-DBOOST_SYSTEM_NO_DEPRECATED)
Ed Tanouse278c182019-03-13 16:23:37 -0700131add_definitions (-DBOOST_ASIO_NO_DEPRECATED)
Ed Tanous1e439872018-05-18 11:48:52 -0700132add_definitions (-DBOOST_ALL_NO_LIB)
133add_definitions (-DBOOST_NO_RTTI)
134add_definitions (-DBOOST_NO_TYPEID)
Ed Tanousc85eb8b2018-10-16 14:59:20 -0700135add_definitions (-DBOOST_COROUTINES_NO_DEPRECATION_WARNING)
Ed tanous7d95f5f2018-03-23 00:19:20 -0700136
Ed Tanous1e439872018-05-18 11:48:52 -0700137find_package (Boost 1.66 REQUIRED)
138include_directories (${BOOST_SRC_DIR})
Ed Tanousaa2e59c2018-04-12 12:17:20 -0700139
140# sdbusplus
Ed Tanous1e439872018-05-18 11:48:52 -0700141if (NOT ${YOCTO_DEPENDENCIES})
James Feista975e9f2018-08-08 14:03:49 -0700142 include_directories (${CMAKE_BINARY_DIR}/sdbusplus-src)
143 link_directories (${CMAKE_BINARY_DIR}/sdbusplus-src/.libs)
Ed Tanous1e439872018-05-18 11:48:52 -0700144endif ()
Ed Tanous0fdddb12017-02-28 11:06:34 -0800145
Ed Tanous580f3722018-03-13 16:59:02 -0700146# Openssl
Ed Tanous1e439872018-05-18 11:48:52 -0700147find_package (OpenSSL REQUIRED)
148include_directories (${OPENSSL_INCLUDE_DIR})
149message ("OPENSSL_INCLUDE_DIR ${OPENSSL_INCLUDE_DIR}")
Ed Tanous0fdddb12017-02-28 11:06:34 -0800150
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700151# bmcweb
Ed Tanous1e439872018-05-18 11:48:52 -0700152message ("CMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}")
153if (CMAKE_BUILD_TYPE MATCHES Debug)
154 message ("Logging disabled")
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700155 add_definitions (-DBMCWEB_ENABLE_LOGGING)
156 add_definitions (-DBMCWEB_ENABLE_DEBUG)
Ed Tanous1e439872018-05-18 11:48:52 -0700157endif (CMAKE_BUILD_TYPE MATCHES Debug)
Ed Tanousaa2e59c2018-04-12 12:17:20 -0700158
Andrew Geissler1f2fbf22018-07-17 07:57:30 -0700159if (NOT "${BMCWEB_INSECURE_DISABLE_SSL}")
Ed Tanousa434f2b2018-07-27 13:04:22 -0700160 add_definitions (-DBMCWEB_ENABLE_SSL)
Andrew Geissler1f2fbf22018-07-17 07:57:30 -0700161endif (NOT "${BMCWEB_INSECURE_DISABLE_SSL}")
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700162include_directories (${CMAKE_CURRENT_SOURCE_DIR}/crow/include)
Ed Tanous0fdddb12017-02-28 11:06:34 -0800163
Ed Tanous580f3722018-03-13 16:59:02 -0700164# Zlib
Ed Tanous1e439872018-05-18 11:48:52 -0700165find_package (ZLIB REQUIRED)
166include_directories (${ZLIB_INCLUDE_DIRS})
Ed Tanousf9273472017-02-28 16:05:13 -0800167
Ed Tanous4758d5b2017-06-06 15:28:13 -0700168# PAM
Ed Tanous1e439872018-05-18 11:48:52 -0700169option (WEBSERVER_ENABLE_PAM "enable pam authentication" ON)
170if ("${WEBSERVER_ENABLE_PAM}")
171 find_package (PAM REQUIRED)
172else ()
173 add_definitions ("-DWEBSERVER_DISABLE_PAM")
174endif ()
Ed Tanous911ac312017-08-15 09:37:42 -0700175
Ed Tanousf0d73c22018-07-26 14:24:20 -0700176add_definitions ("-Wno-attributes")
Jennifer Lee03346702018-05-23 14:05:20 -0700177# Copy pam-webserver to etc/pam.d
Ed Tanousf0d73c22018-07-26 14:24:20 -0700178install (
179 FILES ${CMAKE_CURRENT_SOURCE_DIR}/pam-webserver
180 DESTINATION /etc/pam.d/
181 RENAME webserver
182)
Ed Tanous5f34a9c2017-02-28 12:35:13 -0800183
Ed tanous7d95f5f2018-03-23 00:19:20 -0700184# tinyxml2
Ed Tanous1e439872018-05-18 11:48:52 -0700185find_package (tinyxml2 REQUIRED)
Ed tanous7d95f5f2018-03-23 00:19:20 -0700186
Ed Tanous1e439872018-05-18 11:48:52 -0700187set (WEBSERVER_MAIN src/webserver_main.cpp)
Ed Tanousb4d29f42017-03-24 16:39:25 -0700188
Ed Tanous1e439872018-05-18 11:48:52 -0700189include_directories (${CMAKE_CURRENT_SOURCE_DIR}/include)
190include_directories (${CMAKE_CURRENT_SOURCE_DIR}/redfish-core/include)
Ed Tanousb4d29f42017-03-24 16:39:25 -0700191
Ed Tanous1e439872018-05-18 11:48:52 -0700192file (MAKE_DIRECTORY ${CMAKE_BINARY_DIR}/include/bmcweb)
Ed Tanous1e439872018-05-18 11:48:52 -0700193include_directories (${CMAKE_BINARY_DIR}/include)
Ed Tanous5f34a9c2017-02-28 12:35:13 -0800194
Ed Tanousf0d73c22018-07-26 14:24:20 -0700195set (
196 SRC_FILES redfish-core/src/error_messages.cpp
197 redfish-core/src/utils/json_utils.cpp ${GENERATED_SRC_FILES}
198)
Ed Tanous93f987d2017-04-17 17:52:36 -0700199
Ed Tanous1e439872018-05-18 11:48:52 -0700200file (COPY src/test_resources DESTINATION ${CMAKE_CURRENT_BINARY_DIR})
Ed Tanous911ac312017-08-15 09:37:42 -0700201
Ed Tanous38bdb982017-03-03 14:19:33 -0800202# Unit Tests
Ed Tanous1e439872018-05-18 11:48:52 -0700203if (${BMCWEB_BUILD_UT})
Ed Tanousf0d73c22018-07-26 14:24:20 -0700204 set (
205 UT_FILES src/crow_test.cpp src/gtest_main.cpp
206 src/token_authorization_middleware_test.cpp
207 src/security_headers_middleware_test.cpp src/webassets_test.cpp
208 src/crow_getroutes_test.cpp src/ast_jpeg_decoder_test.cpp
209 src/kvm_websocket_test.cpp src/msan_test.cpp
210 src/ast_video_puller_test.cpp src/openbmc_jtag_rest_test.cpp
211 redfish-core/ut/privileges_test.cpp
212 ${CMAKE_BINARY_DIR}/include/bmcweb/blns.hpp
213 ) # big list of naughty strings
214 add_custom_command (
215 OUTPUT ${CMAKE_BINARY_DIR}/include/bmcweb/blns.hpp
216 COMMAND
217 xxd -i ${CMAKE_CURRENT_SOURCE_DIR}/src/test_resources/blns
218 ${CMAKE_BINARY_DIR}/include/bmcweb/blns.hpp
219 )
Ed Tanous1e439872018-05-18 11:48:52 -0700220
Ed Tanousf0d73c22018-07-26 14:24:20 -0700221 set_source_files_properties (
222 ${CMAKE_BINARY_DIR}/include/bmcweb/blns.hpp PROPERTIES GENERATED TRUE
223 )
Ed Tanous1e439872018-05-18 11:48:52 -0700224 enable_testing ()
225
226 add_executable (webtest ${SRC_FILES} ${UT_FILES})
227
228 find_package (GTest REQUIRED)
229 find_package (GMock REQUIRED)
230 target_link_libraries (webtest ${GTEST_LIBRARIES})
231 target_link_libraries (webtest ${GMOCK_LIBRARIES})
232
233 target_link_libraries (webtest pthread)
234 target_link_libraries (webtest ${OPENSSL_LIBRARIES})
235 target_link_libraries (webtest ${ZLIB_LIBRARIES})
236 target_link_libraries (webtest pam)
237 target_link_libraries (webtest tinyxml2)
Ed Tanousd425c6f2018-05-16 10:20:11 -0700238 target_link_libraries (webtest sdbusplus)
Ed Tanouse0625902018-05-16 13:35:08 -0700239 target_link_libraries (webtest -lsystemd)
Ed Tanous1e439872018-05-18 11:48:52 -0700240 target_link_libraries (webtest -lstdc++fs)
241 add_test (webtest webtest "--gtest_output=xml:webtest.xml")
242
243endif (${BMCWEB_BUILD_UT})
244
245install (DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/static/ DESTINATION share/www)
246
247# bmcweb
248add_executable (bmcweb ${WEBSERVER_MAIN} ${HDR_FILES} ${SRC_FILES})
Ed Tanous1e439872018-05-18 11:48:52 -0700249target_link_libraries (bmcweb ${OPENSSL_LIBRARIES})
250target_link_libraries (bmcweb ${ZLIB_LIBRARIES})
251target_link_libraries (bmcweb pam)
Brad Bishop79ba46f2018-11-29 10:57:31 -0500252target_link_libraries (bmcweb -latomic)
Ed Tanous1e439872018-05-18 11:48:52 -0700253target_link_libraries (bmcweb -lsystemd)
254target_link_libraries (bmcweb -lstdc++fs)
Ed Tanousd425c6f2018-05-16 10:20:11 -0700255target_link_libraries (bmcweb sdbusplus)
Ed Tanous1e439872018-05-18 11:48:52 -0700256target_link_libraries (bmcweb tinyxml2)
257install (TARGETS bmcweb DESTINATION bin)
258
Jason M. Billsc50fc5a2018-11-14 14:49:59 -0800259target_compile_definitions (
260 bmcweb PRIVATE
261 $<$<BOOL:${BMCWEB_ENABLE_KVM}>: -DBMCWEB_ENABLE_KVM>
262 $<$<BOOL:${BMCWEB_ENABLE_DBUS_REST}>: -DBMCWEB_ENABLE_DBUS_REST>
263 $<$<BOOL:${BMCWEB_ENABLE_REDFISH}>: -DBMCWEB_ENABLE_REDFISH>
264 $<$<BOOL:${BMCWEB_ENABLE_STATIC_HOSTING}>: -DBMCWEB_ENABLE_STATIC_HOSTING>
265 $<$<BOOL:${BMCWEB_ENABLE_HOST_SERIAL_WEBSOCKET}>: -DBMCWEB_ENABLE_HOST_SERIAL_WEBSOCKET>
266 $<$<BOOL:${BMCWEB_INSECURE_DISABLE_CSRF_PREVENTION}>: -DBMCWEB_INSECURE_DISABLE_CSRF_PREVENTION>
267 $<$<BOOL:${BMCWEB_INSECURE_DISABLE_SSL}>: -DBMCWEB_INSECURE_DISABLE_SSL>
268 $<$<BOOL:${BMCWEB_INSECURE_DISABLE_XSS_PREVENTION}>: -DBMCWEB_INSECURE_DISABLE_XSS_PREVENTION>
269 $<$<BOOL:${BMCWEB_ENABLE_REDFISH_RAW_PECI}>: -DBMCWEB_ENABLE_REDFISH_RAW_PECI>
270 $<$<BOOL:${BMCWEB_ENABLE_REDFISH_CPU_LOG}>: -DBMCWEB_ENABLE_REDFISH_CPU_LOG>
Jason M. Billsc4bf6372018-11-05 13:48:27 -0800271 $<$<BOOL:${BMCWEB_ENABLE_REDFISH_BMC_JOURNAL}>: -DBMCWEB_ENABLE_REDFISH_BMC_JOURNAL>
Gunnar Mills603a6642019-01-21 17:03:51 -0600272 $<$<BOOL:${BMCWEB_ENABLE_REDFISH_ONE_CHASSIS}>: -DBMCWEB_ENABLE_REDFISH_ONE_CHASSIS>
Andrew Geisslercb92c032018-08-17 07:56:14 -0700273 $<$<BOOL:${BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES}>: -DBMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES>
274
Brad Bishopf5e906b2018-11-29 10:55:10 -0500275)