Ettercap · sgeto · Apr 10, 2018 · Apr 10, 2018 · Apr 10, 2018 · Apr 10, 2018
diff --git a/.gitignore b/.gitignore
@@ -53,6 +53,8 @@ tags
 gmon.out
 ettercap-*_debug.log
 libwdg-*_debug.log
-build/
+build*
 include/config.h
 /obj-*/
+CMakeFiles
+CMakeCache.txt
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,41 +1,36 @@
-cmake_minimum_required(VERSION 2.8)
-project(ettercap C)
+cmake_minimum_required(VERSION 3.0 FATAL_ERROR)
+project(ettercap VERSION 0.8.3 LANGUAGES C)
 
-set(VERSION "0.8.2")
-
-set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake/Modules")
+# Include our cmake modules
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake/Modules")
 set(CMAKE_SCRIPT_PATH "${CMAKE_SOURCE_DIR}/cmake/Scripts")
 
-include(MacroEnsureOutOfSourceBuild)
-macro_ensure_out_of_source_build("${PROJECT_NAME} requires an out of source build.
-Please create a separate build directory and run 'cmake /path/to/${PROJECT_NAME} [options]' there.")
+include(EttercapMacrosAndFunctions)
+
+ensure_out_of_source_build()
+
+include(EttercapOSTest)
+
+# USER OPTIONS
+# ============
+
+include(CMakeDependentOption)
+
+cmake_dependent_option(ENABLE_CURSES "Enable curses interface" ON
+  "NOT OS_WINDOWS;NOT LIBRARY_BUILD" OFF)
 
-option(ENABLE_CURSES "Enable curses interface" ON)
-option(ENABLE_GTK "Enable GTK interface" ON)
+cmake_dependent_option(ENABLE_GTK "Enable GTK interface" ON
+  "NOT LIBRARY_BUILD" OFF)
 option(ENABLE_PLUGINS "Enable plugins support" ON)
 option(ENABLE_IPV6 "Enable IPv6 support" OFF)
 option(ENABLE_LUA "Enable LUA support (EXPERIMENTAL)" OFF)
 option(ENABLE_PDF_DOCS "Enable PDF document generation" OFF)
 option(ENABLE_TESTS "Enable Unit Tests" OFF)
 option(ENABLE_GEOIP "Build with GeoIP support" ON)
 option(LIBRARY_BUILD "Build for libettercap only" OFF)
-option(INSTALL_DESKTOP "Install ettercap desktop files" ON)
 
-
-set(VALID_BUILD_TYPES Debug Release RelWithDebInfo)
-
-if(NOT CMAKE_BUILD_TYPE)
-  # Default to using "Release" as our build type.
-  set(CMAKE_BUILD_TYPE "Release" CACHE STRING
-    "Choose the type of build, options are: ${VALID_BUILD_TYPES}." FORCE)
-endif()
-list(FIND VALID_BUILD_TYPES ${CMAKE_BUILD_TYPE} contains_valid)
-if(contains_valid EQUAL -1)
-  message(FATAL_ERROR "Unknown CMAKE_BUILD_TYPE: '${CMAKE_BUILD_TYPE}'. Valid options are: ${VALID_BUILD_TYPES}")
-endif()
-unset(contains_valid)
-
-include(CMakeDependentOption)
+cmake_dependent_option(INSTALL_DESKTOP "Install ettercap desktop files" ON
+  "NOT OS_WINDOWS" OFF)
 
 # If SYSTEM_LIBS is set to off, then all SYSTEM_* options will be
 # set to off.
@@ -46,114 +41,178 @@ Disabling this implies that we would only use bundled libraries." ON)
 # If BUNDLED_LIBS is set to off, then all BUNDLED_* options will be
 # set to off.
 option(BUNDLED_LIBS
-  "Use bundled libraries if system provided versions are not found (or disabled)" ON)
+  "Use bundled libraries if system provided \
+  versions are not found (or disabled)" ON
+)
 
 cmake_dependent_option(SYSTEM_CURL
   "Search for a system-provided version of Curl" ON
-  SYSTEM_LIBS OFF)
+  SYSTEM_LIBS OFF
+)
 
 cmake_dependent_option(BUNDLED_CURL
-  "Use bundled version of Curl if system-provided version is not found (or disabled)" ON
-  BUNDLED_LIBS OFF)
+  "Use bundled version of Curl if system-provided \
+  version is not found (or disabled)" ON
+  BUNDLED_LIBS OFF
+)
 
 cmake_dependent_option(SYSTEM_LIBNET
   "Search for a system-provided version of LIBNET" ON
-  SYSTEM_LIBS OFF)
+  SYSTEM_LIBS OFF
+)
 
 cmake_dependent_option(BUNDLED_LIBNET
-  "Use bundled version of LIBNET if system-provided version is not found (or disabled)" ON
-  BUNDLED_LIBS OFF)
+  "Use bundled version of LIBNET if system-provided \
+  version is not found (or disabled)" ON
+  BUNDLED_LIBS OFF
+)
 
 cmake_dependent_option(SYSTEM_LUAJIT
   "Search for a system-provided version of LUAJIT" ON
-  "SYSTEM_LIBS;ENABLE_LUA" OFF)
+  "SYSTEM_LIBS;ENABLE_LUA" OFF
+)
 
 cmake_dependent_option(BUNDLED_LUAJIT
-  "Use bundled version of LUAJIT if system-provided version is not found (or disabled)" ON
-  "BUNDLED_LIBS;ENABLE_LUA" OFF)
+  "Use bundled version of LUAJIT if system-provided \
+  version is not found (or disabled)" ON
+  "BUNDLED_LIBS;ENABLE_LUA" OFF
+)
 
 if(ENABLE_TESTS)
-cmake_dependent_option(SYSTEM_LIBCHECK
-  "Search for a system-provided version of LIBCHECK" ON
-  SYSTEM_LIBS OFF)
-
-cmake_dependent_option(BUNDLED_LIBCHECK
-  "Use bundled version of LIBCHECK if system-provided version is not found (or disabled)" ON
-  BUNDLED_LIBS OFF)
+  cmake_dependent_option(SYSTEM_LIBCHECK
+    "Search for a system-provided version of LIBCHECK" ON
+    SYSTEM_LIBS OFF
+  )
+
+  cmake_dependent_option(BUNDLED_LIBCHECK
+    "Use bundled version of LIBCHECK if system-provided \
+    version is not found (or disabled)" ON
+    BUNDLED_LIBS OFF
+  )
 endif()
 
-set(SPECIAL_LIB_DIR "" CACHE PATH "Special (non-traditional) root directory where headers/libraries are installed")
-
+# XXX - you look lost...
 include(CheckVariableInHeaders)
-include(EttercapOSTest)
 
-#Check and see if we're running Darwin, specify the CMAKE_LIBARY_PATH to do so
-if(OS_DARWIN)
-  set(CMAKE_SYSTEM_NAME Darwin)
-  set(CMAKE_LIBRARY_PATH ${SPECIAL_LIB_DIR}/lib ${CMAKE_LIBRARY_PATH})
-  set(CMAKE_INCLUDE_PATH ${SPECIAL_LIB_DIR}/include ${CMAKE_INCLUDE_PATH})
-else()
-  set(CMAKE_LIBRARY_PATH ${CMAKE_LIBRARY_PATH} /usr/lib64 /usr/lib32)
-endif()
-
-if(LIBRARY_BUILD)
-  set(ENABLE_GTK OFF)
-  set(ENABLE_CURSES OFF)
-  set(JUST_LIBRARY 1)
+# XXX - remove this or move this lower
+if(NOT OS_DARWIN AND NOT OS_WINDOWS)
+  set(FIND_LIBRARY_USE_LIB32_PATHS 1)
+  set(FIND_LIBRARY_USE_LIB64_PATHS 1)
 endif()
 
+# XXX - move this lower
 include(EttercapHeadersCheck)
 include(EttercapLibCheck)
 include(EttercapVariableCheck)
 
+# INSTALL AND/OR OUTPUT DIRECTORIES
+# =================================
+
 set(INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX} CACHE PATH "Installation prefix")
-set(INSTALL_SYSCONFDIR /etc CACHE PATH "System configuration directory")
-set(INSTALL_LIBDIR ${INSTALL_PREFIX}/lib${LIB_SUFFIX} CACHE PATH "Library installation directory")
-set(INSTALL_DATADIR ${INSTALL_PREFIX}/share CACHE PATH "Data installation directory")
+
+if(UNIX)
+  set(INSTALL_SYSCONFDIR /etc CACHE PATH "System configuration directory")
+  else()
+  set(INSTALL_SYSCONFDIR
+    ${INSTALL_PREFIX}/etc CACHE PATH "System configuration directory"
+  )
+endif()
+
+set(INSTALL_LIBDIR
+  ${INSTALL_PREFIX}/lib${LIB_SUFFIX} CACHE PATH
+  "Library installation directory"
+)
+
+set(INSTALL_DATADIR
+  ${INSTALL_PREFIX}/share CACHE PATH "Data installation directory"
+)
+
 set(INSTALL_EXECPREFIX ${INSTALL_PREFIX} CACHE PATH "")
-set(INSTALL_BINDIR  ${INSTALL_PREFIX}/bin CACHE PATH "Binary files installation directory")
+set(INSTALL_BINDIR
+  ${INSTALL_PREFIX}/bin CACHE PATH "Binary files installation directory"
+)
+
 if(OS_DARWIN OR OS_WINDOWS)
-  set(POLKIT_DIR ${INSTALL_PREFIX}/share/polkit-1/actions/ CACHE PATH "Polkit installation directory")
+  set(POLKIT_DIR
+    ${INSTALL_PREFIX}/share/polkit-1/actions/ CACHE PATH
+    "Polkit installation directory"
+  )
 else()
-#at least on ubuntu, polkit dir couldn't be /usr/local/share, but should be /usr/share
-  set(POLKIT_DIR /usr/share/polkit-1/actions/ CACHE PATH "Polkit installation directory")
+# at least on ubuntu, polkit dir couldn't be /usr/local/share,
+# but should be /usr/share
+  set(POLKIT_DIR
+    /usr/share/polkit-1/actions/ CACHE PATH "Polkit installation directory"
+  )
 endif()
-set(PKEXEC_INSTALL_WRAPPER org.pkexec.ettercap CACHE PATH "Name of the pkexec action file")
-set(DESKTOP_DIR ${INSTALL_PREFIX}/share/applications/ CACHE PATH "Desktop file installation directory")
-set(APPDATA_DIR ${INSTALL_PREFIX}/share/appdata/ CACHE PATH "Appdata file installation directory")
-set(ICON_DIR ${INSTALL_PREFIX}/share/pixmaps CACHE PATH "Icon file installation directory")
-set(MAN_INSTALLDIR ${INSTALL_PREFIX}/share/man CACHE PATH "Path for manual pages")
 
+set(PKEXEC_INSTALL_WRAPPER
+  org.pkexec.ettercap CACHE PATH "Name of the pkexec action file"
+)
+
+set(DESKTOP_DIR
+  ${INSTALL_PREFIX}/share/applications/ CACHE PATH
+  "Desktop file installation directory"
+)
+
+set(APPDATA_DIR
+  ${INSTALL_PREFIX}/share/appdata/ CACHE PATH
+  "Appdata file installation directory"
+)
+
+set(ICON_DIR
+  ${INSTALL_PREFIX}/share/pixmaps CACHE PATH "Icon file installation directory"
+)
+
+set(MAN_INSTALLDIR
+  ${INSTALL_PREFIX}/share/man CACHE PATH "Path for manual pages"
+)
+
+# XXX - remove this or move this into correct section
 if(NOT DISABLE_RPATH)
   # Ensure that, when we link to stuff outside of our build path, we include the
   # library dir path in our RPATH.
   set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
   set(CMAKE_MACOSX_RPATH 1)
 endif()
 
-# set general build flags for debug build-type
-set(CMAKE_C_FLAGS_DEBUG "-O0 -ggdb3 -DDEBUG -Wall -Wno-pointer-sign -D_FORTIFY_SOURCE=2 -Wformat -Wformat-security -Werror=format-security -Wextra -Wredundant-decls" CACHE STRING "" FORCE)
-## append ASAN build flags if compiler version has support
-#if("${CMAKE_C_COMPILER_ID}" STREQUAL "GNU")
-#   if(CMAKE_C_COMPILER_VERSION VERSION_GREATER 4.8)
-#      set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -fsanitize=address
-#         -fno-omit-frame-pointer" CACHE STRING "" FORCE)
-#      message("Building with ASAN support (GNU compiler)")
-#   else()
-#      message("Building without ASAN support (GNU compiler)")
-#   endif()
-#elseif("${CMAKE_C_COMPILER_ID}" STREQUAL "Clang")
-#   if(CMAKE_C_COMPILER_VERSION VERSION_GREATER 3.1)
-#      set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -fsanitize=address
-#         -fno-omit-frame-pointer" CACHE STRING "" FORCE)
-#      message("Building with ASAN support (Clang compiler)")
-#   elseif(CMAKE_C_COMPILER_VERSION VERSION_GREATER 3.1)
-#      message("Building without ASAN support (Clang compiler)")
-#   endif()
-#endif()
-
-# set build flags for release build-type
-set(CMAKE_C_FLAGS_RELEASE "-O2 -w -D_FORTIFY_SOURCE=2" CACHE STRING "" FORCE)
+# GLOBAL BUILD FLAGS
+# ==================
+
+# XXX - move this line to EttercapOSTest.cmake
+get_property(IS_MULTI_CONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
+
+set(VALID_BUILD_TYPES "Debug, Release, RelWithDebInfo and MinSizeRel")
+if(NOT CMAKE_BUILD_TYPE AND NOT "${IS_MULTI_CONFIG}")
+  # On "single-configuration generators", default to the "Release" build type.
+  set(CMAKE_BUILD_TYPE "Release" CACHE STRING
+    "Choose the type of build, options are: ${VALID_BUILD_TYPES}." FORCE
+  )
+endif()
+
+add_definitions(-D_FORTIFY_SOURCE=2)
+
+if(CMAKE_BUILD_TYPE STREQUAL "Debug" OR CMAKE_CONFIGURATION_TYPES)
+# Set build flags for debug builds
+
+  add_definitions(-DDEBUG)
+  add_definitions(-D_DEBUG)
+
+  # Check and add compiler options if they exist.
+  # ---------------------------------------------
+  #
+  # You may add any kind of compiler flag to this.
+  # If your compiler supports it, it will be added, if not, it will be skipped.
+  check_and_add_compiler_option(-O0)
+  check_and_add_compiler_option(-ggdb3)
+  check_and_add_compiler_option(-Wall)
+  check_and_add_compiler_option(-Wno-pointer-sign)
+  check_and_add_compiler_option(-Wformat)
+  check_and_add_compiler_option(-Werror=format-security)
+  check_and_add_compiler_option(-Wextra)
+  check_and_add_compiler_option(-Wredundant-decls)
+  check_and_add_compiler_option(-W4) # MSVC only
+  check_and_add_compiler_option(-Wused-but-marked-unused) # Clang/llVM only
+endif()
 
 if(OS_DARWIN)
 set(CMAKE_EXE_LINKER_FLAGS "-Wl" CACHE STRING "" FORCE)
@@ -166,7 +225,10 @@ if(ENABLE_LUA)
   set(HAVE_EC_LUA 1)
 endif()
 
-set(EC_INCLUDE_PATH ${CMAKE_CURRENT_BINARY_DIR}/include ${CMAKE_SOURCE_DIR}/include ${EC_INCLUDE})
+set(EC_INCLUDE_PATH ${CMAKE_CURRENT_BINARY_DIR}/include
+  ${CMAKE_SOURCE_DIR}/include ${EC_INCLUDE}
+)
+
 include_directories(${EC_INCLUDE_PATH})
 
 add_subdirectory(src)
@@ -176,22 +238,24 @@ if(INSTALL_DESKTOP)
 endif()
 
 if(HAVE_PLUGINS)
-    if(OS_MINGW)
-        message("Sorry, plugins support on Windows is currently unavailable")
-    else()
-        add_subdirectory(plug-ins)
-    endif()
+  if(OS_WINDOWS)
+    message("Sorry, plugins support on Windows is currently unavailable")
+  else()
+    add_subdirectory(plug-ins)
+  endif()
 endif()
 add_subdirectory(utils)
 add_subdirectory(share)
 add_subdirectory(man)
 
 if(ENABLE_IPV6)
-    set(WITH_IPV6 TRUE)
+  set(WITH_IPV6 TRUE)
 endif()
 
 # This line should ALWAYS be after all options are defined
-configure_file(include/config.h.cmake ${CMAKE_CURRENT_BINARY_DIR}/include/config.h)
+configure_file(include/config.h.cmake
+  ${CMAKE_CURRENT_BINARY_DIR}/include/config.h
+)
 
 if(ENABLE_TESTS)
   enable_testing()
@@ -200,12 +264,14 @@ endif()
 
 # uninstall target
 configure_file(
-    "${CMAKE_SCRIPT_PATH}/cmake_uninstall.cmake.in"
-    "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake"
-    IMMEDIATE @ONLY)
+  "${CMAKE_SCRIPT_PATH}/cmake_uninstall.cmake.in"
+  "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake"
+  IMMEDIATE @ONLY
+)
 
 add_custom_target(uninstall
-    COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake)
+  COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake
+)
 
 # Add a target that will ensure that the build directory is properly cleaned.
 add_custom_target(clean-all