Merge pull request #1480 from jan-cerny/yamlfilecontent_probe

yamlfilecontent probe

Author: yuumasato

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "yaml-filter"]
+	path = yaml-filter
+	url = https://github.com/OpenSCAP/yaml-filter.git

CMakeLists.txt

@@ -164,6 +164,15 @@ if(GCRYPT_FOUND OR NSS_FOUND)
 	set(CRYPTO_FOUND TRUE)
 endif()
 
+find_package(Libyaml)
+if(EXISTS ${CMAKE_SOURCE_DIR}/yaml-filter/CMakeLists.txt)
+	message(STATUS "yaml-filter was found")
+	set(YAML_FILTER_FOUND TRUE)
+else()
+	message(STATUS "yaml-filter was not found")
+	set(YAML_FILTER_FOUND FALSE)
+endif()
+
 check_library_exists(rt clock_gettime "" HAVE_CLOCK_GETTIME)
 check_function_exists(posix_memalign HAVE_POSIX_MEMALIGN)
 check_function_exists(memalign HAVE_MEMALIGN)
@@ -235,6 +244,7 @@ cmake_dependent_option(OPENSCAP_PROBE_INDEPENDENT_TEXTFILECONTENT "Independent t
 cmake_dependent_option(OPENSCAP_PROBE_INDEPENDENT_TEXTFILECONTENT54 "Independent textfilecontent54 probe" ON "ENABLE_PROBES_INDEPENDENT; NOT WIN32" OFF)
 cmake_dependent_option(OPENSCAP_PROBE_INDEPENDENT_VARIABLE "Independent variable probe" ON "ENABLE_PROBES_INDEPENDENT" OFF)
 cmake_dependent_option(OPENSCAP_PROBE_INDEPENDENT_XMLFILECONTENT "Independent xmlfilecontent probe" ON "ENABLE_PROBES_INDEPENDENT; NOT WIN32" OFF)
+cmake_dependent_option(OPENSCAP_PROBE_INDEPENDENT_YAMLFILECONTENT "Independent yamlfilecontent probe" ON "ENABLE_PROBES_INDEPENDENT; LIBYAML_FOUND; YAML_FILTER_FOUND; NOT WIN32" OFF)
 
 # UNIX PROBES
 cmake_dependent_option(OPENSCAP_PROBE_UNIX_DNSCACHE "Unix dnscache probe" ON "ENABLE_PROBES_UNIX" OFF)
@@ -358,6 +368,7 @@ message(STATUS "  Independent sql57 probe (depends on opendbx): ${OPENSCAP_PROBE
 message(STATUS "  Independent textfilecontent probe: ${OPENSCAP_PROBE_INDEPENDENT_TEXTFILECONTENT}")
 message(STATUS "  Independent textfilecontent54 probe: ${OPENSCAP_PROBE_INDEPENDENT_TEXTFILECONTENT54}")
 message(STATUS "  Independent xmlfilecontent probe: ${OPENSCAP_PROBE_INDEPENDENT_XMLFILECONTENT}")
+message(STATUS "  Independent yamlfilecontent probe (depends on libyaml, yaml-path): ${OPENSCAP_PROBE_INDEPENDENT_YAMLFILECONTENT}")
 message(STATUS " ")
 
 
@@ -526,6 +537,7 @@ include_directories(
 	"src/XCCDF/public/"
 	"src/XCCDF_POLICY/"
 	"src/XCCDF_POLICY/public/"
+	"yaml-filter"
 	${CMAKE_BINARY_DIR} # config.h is generated to build directory
 	${LIBXML2_INCLUDE_DIR}
 )
@@ -548,6 +560,11 @@ function(set_oscap_generic_properties TARGET_OBJECT)
 	target_compile_definitions(${TARGET_OBJECT} PRIVATE OSCAP_BUILD_SHARED)
 endfunction()
 
+if(OPENSCAP_PROBE_INDEPENDENT_YAMLFILECONTENT)
+	add_library(yamlfilter_object OBJECT yaml-filter/yaml-path.c yaml-filter/yaml-path.h)
+	set_oscap_generic_properties(yamlfilter_object)
+endif()
+
 add_subdirectory("compat")
 add_subdirectory("src")
 add_subdirectory("utils")

cmake/FindLibyaml.cmake

@@ -0,0 +1,29 @@
+# - Try to find libyaml
+# Once done, this will define
+#
+#  LIBYAML_FOUND - system has libyaml
+#  LIBYAML_INCLUDE_DIRS - the libyaml include directories
+#  LIBYAML_LIBRARIES - link these to use libyaml
+
+include(LibFindMacros)
+
+# Use pkg-config to get hints about paths
+libfind_pkg_check_modules(LIBYAML_PKGCONF yaml-0.1)
+
+# Include dir
+find_path(LIBYAML_INCLUDE_DIR
+	NAMES yaml.h
+	PATHS ${LIBYAML_PKGCONF_INCLUDE_DIRS}
+)
+
+# Finally the library itself
+find_library(LIBYAML_LIBRARY
+	NAMES libyaml.so
+	PATHS ${LIBYAML_PKGCONF_LIBRARY_DIRS}
+)
+
+# Set the include dir variables and the libraries and let libfind_process do the rest.
+# NOTE: Singular variables for this library, plural for libraries this this lib depends on.
+set(LIBYAML_PROCESS_INCLUDES LIBYAML_INCLUDE_DIR)
+set(LIBYAML_PROCESS_LIBS LIBYAML_LIBRARY)
+libfind_process(LIBYAML)

config.h.in

@@ -95,6 +95,7 @@
 #cmakedefine OPENSCAP_PROBE_INDEPENDENT_TEXTFILECONTENT54
 #cmakedefine OPENSCAP_PROBE_INDEPENDENT_VARIABLE
 #cmakedefine OPENSCAP_PROBE_INDEPENDENT_XMLFILECONTENT
+#cmakedefine OPENSCAP_PROBE_INDEPENDENT_YAMLFILECONTENT
 #cmakedefine OPENSCAP_PROBE_LINUX_DPKGINFO
 #cmakedefine OPENSCAP_PROBE_LINUX_IFLISTENERS
 #cmakedefine OPENSCAP_PROBE_LINUX_INETLISTENINGSERVERS

docs/developer/developer.adoc

@@ -31,11 +31,15 @@ mkdir -p build
 .. Use fresh sources from git repository.
 +
 ----
-$ git clone https://github.com/OpenSCAP/openscap.git
+$ git clone --recurse-submodules https://github.com/OpenSCAP/openscap.git
 $ cd openscap
 ----
 +
 
+NOTE: We include https://github.com/OpenSCAP/yaml-filter[yaml-filter] library
+as a git submodule. To get more information about using git submodules, read
+https://git-scm.com/book/en/v2/Git-Tools-Submodules[Git Tools - Submodules].
+
 . *Get the build dependencies*
 +
 --
@@ -52,7 +56,7 @@ sudo yum install \
 cmake dbus-devel GConf2-devel libacl-devel libblkid-devel libcap-devel libcurl-devel \
 libgcrypt-devel libselinux-devel libxml2-devel libxslt-devel libattr-devel make openldap-devel \
 pcre-devel perl-XML-Parser perl-XML-XPath perl-devel python-devel rpm-devel swig \
-bzip2-devel gcc-c++
+bzip2-devel gcc-c++ libyaml-devel
 ----
 
 On Fedora 24+, the command to install the build dependencies is:
@@ -62,7 +66,7 @@ sudo yum install \
 cmake dbus-devel GConf2-devel libacl-devel libblkid-devel libcap-devel libcurl-devel \
 libgcrypt-devel libselinux-devel libxml2-devel libxslt-devel libattr-devel make openldap-devel \
 pcre-devel perl-XML-Parser perl-XML-XPath perl-devel python3-devel rpm-devel swig \
-bzip2-devel gcc-c++
+bzip2-devel gcc-c++ libyaml-devel
 ----
 
 On RHEL 8 / CentOS 8, the command to install the build dependencies is:
@@ -72,7 +76,7 @@ sudo yum install \
 cmake dbus-devel libacl-devel libblkid-devel libcap-devel libcurl-devel \
 libgcrypt-devel libselinux-devel libxml2-devel libxslt-devel libattr-devel make openldap-devel \
 pcre-devel perl-XML-Parser perl-XML-XPath perl-devel python36-devel rpm-devel swig \
-bzip2-devel gcc-c++
+bzip2-devel gcc-c++ libyaml-devel
 ----
 
 On Ubuntu 16.04, Debian 8 or Debian 9, the command to install the build dependencies is:
@@ -81,7 +85,7 @@ On Ubuntu 16.04, Debian 8 or Debian 9, the command to install the build dependen
 sudo apt-get install -y cmake libdbus-1-dev libdbus-glib-1-dev libcurl4-openssl-dev \
 libgcrypt20-dev libselinux1-dev libxslt1-dev libgconf2-dev libacl1-dev libblkid-dev \
 libcap-dev libxml2-dev libldap2-dev libpcre3-dev python-dev swig libxml-parser-perl \
-libxml-xpath-perl libperl-dev libbz2-dev librpm-dev g++ libapt-pkg-dev
+libxml-xpath-perl libperl-dev libbz2-dev librpm-dev g++ libapt-pkg-dev libyaml-dev
 ----
 
 When you have all the build dependencies installed you can build the library.

release_tools/README.adoc

@@ -9,7 +9,7 @@
 
 . Clone a clean `openscap` repository:
 
-   git clone https://github.com/OpenSCAP/openscap.git
+   git clone --recurse-submodules https://github.com/OpenSCAP/openscap.git
 
 . Create `.env` file
 +

release_tools/release.sh

@@ -101,7 +101,7 @@ make_dist()
 check_abi()
 {
     rpm -q abi-compliance-checker || sudo dnf install abi-compliance-checker
-    test -d openscap-abi-check || git clone [email protected]:OpenSCAP/openscap-abi-check.git
+    test -d openscap-abi-check || git clone --recurse-submodules [email protected]:OpenSCAP/openscap-abi-check.git
     openscap_git_branch=$(git branch | grep '^\* ' | cut -f2 -d' ')
     (
         cd openscap-abi-check

src/CMakeLists.txt

@@ -31,6 +31,9 @@ set(OBJECTS_TO_LINK_AGAINST
 if (TARGET "compat_object")
 	list(APPEND OBJECTS_TO_LINK_AGAINST $<TARGET_OBJECTS:compat_object>)
 endif()
+if (TARGET "yamlfilter_object")
+	list(APPEND OBJECTS_TO_LINK_AGAINST $<TARGET_OBJECTS:yamlfilter_object>)
+endif()
 if (ENABLE_PROBES)
 	list(APPEND OBJECTS_TO_LINK_AGAINST
 		$<TARGET_OBJECTS:probe_object>
@@ -121,6 +124,9 @@ endif()
 if(CAP_FOUND)
 	target_link_libraries(openscap ${CAP_LIBRARIES})
 endif()
+if(LIBYAML_FOUND)
+	target_link_libraries(openscap ${LIBYAML_LIBRARIES})
+endif()
 
 if(WIN32)
 	set(OPENSCAP_INSTALL_DESTINATION ".")

src/OVAL/oval_enumerations.c

@@ -492,6 +492,7 @@ static const struct oscap_string_map OVAL_SUBTYPE_INDEPENDENT_MAP[] = {
 	{OVAL_INDEPENDENT_UNKNOWN, "unknown"},
 	{OVAL_INDEPENDENT_VARIABLE, "variable"},
 	{OVAL_INDEPENDENT_XML_FILE_CONTENT, "xmlfilecontent"},
+	{OVAL_INDEPENDENT_YAML_FILE_CONTENT, "yamlfilecontent"},
 	{OVAL_INDEPENDENT_SYSCHAR_SUBTYPE, "system_info"},
 	{OVAL_INDEPENDENT_LDAP57, "ldap57"},
 	{OVAL_INDEPENDENT_LDAP, "ldap"},

src/OVAL/probes/independent/CMakeLists.txt

@@ -82,5 +82,12 @@ if(OPENSCAP_PROBE_INDEPENDENT_XMLFILECONTENT)
 	)
 endif()
 
+if(OPENSCAP_PROBE_INDEPENDENT_YAMLFILECONTENT)
+	list(APPEND INDEPENDENT_PROBES_SOURCES
+		"yamlfilecontent_probe.c"
+		"yamlfilecontent_probe.h"
+	)
+endif()
+
 add_library(independent_probes_object OBJECT ${INDEPENDENT_PROBES_SOURCES})
 set_oscap_generic_properties(independent_probes_object)