6 Commits (ac8f7c17efa2800372038519be59c823e96e5fdb)

Author	SHA1	Message	Date
Micah Snyder	a868a7a055	CMake: Fix find-curses issue with static libs ... If ncurses or pdcurses are static libraries, they are not properly detected. First, the user compiling clamav needs to specify if the include path is for NCURSES or PDCURSES, which will differentiate the two. I've updated the INSTALL.md file to show this. Second, the wrong variable was being used to add the include path to the Curses::curses target, which means that clamdtop would fail to include ncurses.h. I fixed this.	4 years ago
Micah Snyder	e13d752789	INSTALL.md: step-by-step instructions -> docs.clamav.net ... Move all step-by-step instructions for installing dependencies to docs.clamav.net. INSTALL.md serves to direct folks to our online documentation (or the offline copy in the release tarball), and as a reference for all custom config options. Add some introductory CMake material to help people new to CMake. Add un-install instructions. Also fix broken links in README.md.	4 years ago
Micah Snyder	239ede8023	News & Install: updates to prepare for 0.104 RC ... Updates to prepare for the 0.104 release candidate: - Change documentation to explain current bytecode runtime situation. - Document Python 2 pytest issue. - Add additional contributors to acknowledgements. - Update Install instructions to note that Autotool has been removed. - Add *.cat SHA256 support and PDF bytecode hook bugfix to the News. - Clarify purpose of the clamscan `--gen-json` option in the clamscan --help.	4 years ago
Micah Snyder	a746d344df	Remove Autotools build system & built-in LLVM ... CMake is now required to build. The built-in LLVM is no longer available. Also removed support for libltdl calls, which is not used in the CMake builds, was only used when building with Autotools. TODO: Fix CMake LLVM support & update to work with modern versions.	4 years ago
Micah Snyder (micasnyd)	dc7f136d96	INSTALL.cmake.md: Fix copypaste typo	4 years ago
Micah Snyder	d26b71d02d	cmake: Fix vcpkg debug build issues ... Adds support to the pcre2 and pthreadw32 Find<Package>.cmake modules for correctly discovering the debug versions. This change modeled after the upstream FindBZip2.cmake module. Also eliminated HAVE_STRUCT_TIMESPEC redefinition warnings in Windows builds.	4 years ago
Micah Snyder	c81968d3a7	GitHub Actions testing on Ubuntu, Mac, & Windows ... Updates to fix issues in the CMake install instructions. Updates the README.md to indicate that CMake is now preferred Adds a GitHub Actions badge, Discord badge, and logo to the README.md. CMake: - Renamed ENABLE_DOCS to ENABLE_MAN_PAGES. - Fixed build issue when milter isn't enabled on Linux. Changed the default to build milter on non-macOS, non-Windows operating systems. - Fix LD_LIBRARY_PATH for tests including on macOS where LD_LIBRARY_PATH and DYLD_LIBRARY_PATH must be manually propagated to subprocesses. - Use UNKNOWN IMPORTED library instead of INTERFACE IMPORTED library for pdcurses, but still use INTERFACE IMPORTED for ncurses. UNKNOWN IMPORTED appears to be required so that we can use $<TARGET_FILE_DIR:Curses::curses> to collected the pdcurses library at install time on Windows. - When building with vcpkg on Windows, CMake will automatically install your app local dependencies (aka the DLL runtime dependencies). Meanwhile, file(GET_RUNTIME_DEPENDENCIES ...) doesn't appear to work correctly with vcpkg packages. The solution is to use a custom target that has CMake perform a local install to the unit_tests directory when using vcpkg. This is in fact far easier than using GET_RUNTIME_DEPENDENCIES in the unit_tests for assembling the test environment but we can't use this method for the non-vcpkg install because it won't collect checkDynamic.dll for us because we don't install our tests. We also can't link with the static check.lib because the static check.lib has pthreads symbols linked in and will conflict with our pthread.dll. TL;DR: We'll continue to use file(GET_RUNTIME_DEPENDENCIES ...) for assembling the test enviornment on non-vcpkg builds, and use the local install method for vcpkg builds. testcase.py: Wrapped a Pathlib.unlink() call in exception handling as the missing_ok optional parameter requires a Python version too new for common use. Remove localtime_r from win32 compat lib. localtime_r may be present in libcheck when building with vcpkg and while making it a static function would also solve the issue, using localtime_s instead like we do everywhere else should work just fine. check_clamd: Limited the max # of connections for the stress test on Mac to 850, to address issues found testing on macos-latest on GitHub Actions.	4 years ago
Micah Snyder	6b3b8b2e9d	CMake: CPack generate Windows installer with WIX ... Also creates a ZIP for non-Admin (per-user) installs. WIX requires the license file to have a .txt or .rtf extension so I added the .txt extension. I've taken the opportunity to migrate the 3rd party licenses to a COPYING subdirectory and have added licensing details to the README.md file. To build the installer, install WIX and simply run `cpack -C Release` Also removed the explicit --config option from the clamav-clamonacc.service file because it should not be required and isn't being generated correctly when using autotools anyways, especially after changes in this commit.	4 years ago
Micah Snyder	451279876e	CMake: Add fuzz support. ... Enabled the metadata collection feature, scan heuristics, and all-match mode when fuzzing in the interest of better code coverage. Also remove deprecated STREAM command.	4 years ago
Micah Snyder	2552cfd0d1	CMake: Add CTest support to match Autotools checks ... An ENABLE_TESTS CMake option is provided so that users can disable testing if they don't want it. Instructions for how to use this included in the INSTALL.cmake.md file. If you run `ctest`, each testcase will write out a log file to the <build>/unit_tests directory. As with Autotools' make check, the test files are from test/.split and unit_tests/.split files, but for CMake these are generated at build time instead of at test time. On Posix systems, sets the LD_LIBRARY_PATH so that ClamAV-compiled libraries can be loaded when running tests. On Windows systems, CTest will identify and collect all library dependencies and assemble a temporarily install under the build/unit_tests directory so that the libraries can be loaded when running tests. The same feature is used on Windows when using CMake to install to collect all DLL dependencies so that users don't have to install them manually afterwards. Each of the CTest tests are run using a custom wrapper around Python's unittest framework, which is also responsible for finding and inserting valgrind into the valgrind tests on Posix systems. Unlike with Autotools, the CMake CTest Valgrind-tests are enabled by default, if Valgrind can be found. There's no need to set VG=1. CTest's memcheck module is NOT supported, because we use Python to orchestrate our tests. Added a bunch of Windows compatibility changes to the unit tests. These were primarily changing / to PATHSEP and making adjustments to use Win32 C headers and ifdef out the POSIX ones which aren't available on Windows. Also disabled a bunch of tests on Win32 that don't work on Windows, notably the mmap ones and FD-passing (i.e. FILEDES) ones. Add JSON_C_HAVE_INTTYPES_H definition to clamav-config.h to eliminate warnings on Windows where json.h is included after inttypes.h because json-c's inttypes replacement relies on it. This is a it of a hack and may be removed if json-c fixes their inttypes header stuff in the future. Add preprocessor definitions on Windows to disable MSVC warnings about CRT secure and nonstandard functions. While there may be a better solution, this is needed to be able to see other more serious warnings. Add missing file comment block and copyright statement for clamsubmit.c. Also change json-c/json.h include filename to json.h in clamsubmit.c. The directory name is not required. Changed the hash table data integer type from long, which is poorly defined, to size_t -- which is capable of storing a pointer. Fixed a bunch of casts regarding this variable to eliminate warnings. Fixed two bugs causing utf8 encoding unit tests to fail on Windows: - The in_size variable should be the number of bytes, not the character count. This was was causing the SHIFT_JIS (japanese codepage) to UTF8 transcoding test to only transcode half the bytes. - It turns out that the MultiByteToWideChar() API can't transcode UTF16-BE to UTF16-LE. The solution is to just iterate over the buffer and flip the bytes on each uint16_t. This but was causing the UTF16-BE to UTF8 tests to fail. I also split up the utf8 transcoding tests into separate tests so I could see all of the failures instead of just the first one. Added a flags parameter to the unit test function to open testfiles because it turns out that on Windows if a file contains the \r\n it will replace it with just \n if you opened the file as a text file instead of as binary. However, if we open the CBC files as binary, then a bunch of bytecode tests fail. So I've changed the tests to open the CBC files in the bytecode tests as text files and open all other files as binary. Ported the feature tests from shell scripts to Python using a modified version of our QA test-framework, which is largely compatible and will allow us to migrate some QA tests into this repo. I'd like to add GitHub Actions pipelines in the future so that all public PR's get some testing before anyone has to manually review them. The clamd --log option was missing from the help string, though it definitely works. I've added it in this commit. It appears that clamd.c was never clang-format'd, so this commit also reformats clamd.c. Some of the check_clamd tests expected the path returned by clamd to match character for character with original path sent to clamd. However, as we now evaluate real paths before a scan, the path returned by clamd isn't going to match the relative (and possibly symlink-ridden) path passed to clamdscan. I fixed this test by changing the test to search for the basename: <signature> FOUND within the response instead of matching the exact path. Autotools: Link check_clamd with libclamav so we can use our utility functions in check_clamd.c.	4 years ago
Jonas Zaddach (jzaddach)	b7670c0d38	CMake: Support pthreads4w from vcpkg for Windows builds	5 years ago
Micah Snyder (micasnyd)	08bf1822b1	CMake: Remove Flex & Bison hard build dependency ... Flex and Bison are generally available not not particularly easy to install and on macOS, the Bison version is relatively ancient and not compatible. Homebrew doesn't necessarily play nice with Xcode, so to make CMake builds work on macOS without mandating the use of Homebrew, our best option is to make Flex & Bison optional. Flex and Bison generated files will be kept in revision control and will get re-generated only if you use -DMAINTAINER_MODE=ON which will introduce the Flex and Bison tool dependencies. CMake: don't emit fullpath in yara generated source Autotool's ylwrap script has a hack that prevents the full path of the bison & flex generated source from being included in the debug line numbers and in the preprocessor include guard macros. CMake doesn't have this, so when it sets the output file to the full path, the current user's path is leaked into the generated source. Added `%output "yara_grammar.c"` to yara_grammar.y and re-generated the .c & .h file with this change. This overrides the "FILE" setting used when generating those line numbers and include guard macro names so that the path isn't included. Similarly, added `%option outfile="yara_lexer.c` to yara_lexer.l and re-generated the .c file with this change. This has the same effect but for flex so that full filepaths are not emitted into the source. Revert NEWS.md item regarding Flex, Bison change. Revert placing yara grammar/lexer files in win32 compat.	5 years ago
Micah Snyder (micasnyd)	74cb025af0	CMake: Fix libclamav pcre2 include path issue ... The pcre2.h header dependency is propagated to the bytecode runtime, lzma_sdk, yara, and regex build targets within the libclamav build because it is included by matcher.h which is included all over the place. This patch adds the pcre2 dependency to the affected build targets so that systems where pcre2 isn't in the standard include path can still build. Also removed CMake `PCRE2_DIR` from documentation, as it doesn't apply to this PCRE2 detection logic that we settled on.	5 years ago
Micah Snyder (micasnyd)	9e20cdf6ea	Add CMake build tooling ... This patch adds experimental-quality CMake build tooling. The libmspack build required a modification to use "" instead of <> for header #includes. This will hopefully be included in the libmspack upstream project when adding CMake build tooling to libmspack. Removed use of libltdl when using CMake. Flex & Bison are now required to build. If -DMAINTAINER_MODE, then GPERF is also required, though it currently doesn't actually do anything. TODO! I found that the autotools build system was generating the lexer output but not actually compiling it, instead using previously generated (and manually renamed) lexer c source. As a consequence, changes to the .l and .y files weren't making it into the build. To resolve this, I removed generated flex/bison files and fixed the tooling to use the freshly generated files. Flex and bison are now required build tools. On Windows, this adds a dependency on the winflexbison package, which can be obtained using Chocolatey or may be manually installed. CMake tooling only has partial support for building with external LLVM library, and no support for the internal LLVM (to be removed in the future). I.e. The CMake build currently only supports the bytecode interpreter. Many files used include paths relative to the top source directory or relative to the current project, rather than relative to each build target. Modern CMake support requires including internal dependency headers the same way you would external dependency headers (albeit with "" instead of <>). This meant correcting all header includes to be relative to the build targets and not relative to the workspace. For example, ... ```c include "../libclamav/clamav.h" include "clamd/clamd_others.h" ``` ... becomes: ```c // libclamav include "clamav.h" // clamd include "clamd_others.h" ``` Fixes header name conflicts by renaming a few of the files. Converted the "shared" code into a static library, which depends on libclamav. The ironically named "shared" static library provides features common to the ClamAV apps which are not required in libclamav itself and are not intended for use by downstream projects. This change was required for correct modern CMake practices but was also required to use the automake "subdir-objects" option. This eliminates warnings when running autoreconf which, in the next version of autoconf & automake are likely to break the build. libclamav used to build in multiple stages where an earlier stage is a static library containing utils required by the "shared" code. Linking clamdscan and clamdtop with this libclamav utils static lib allowed these two apps to function without libclamav. While this is nice in theory, the practical gains are minimal and it complicates the build system. As such, the autotools and CMake tooling was simplified for improved maintainability and this feature was thrown out. clamdtop and clamdscan now require libclamav to function. Removed the nopthreads version of the autotools libclamav_internal_utils static library and added pthread linking to a couple apps that may have issues building on some platforms without it, with the intention of removing needless complexity from the source. Kept the regular version of libclamav_internal_utils.la though it is no longer used anywhere but in libclamav. Added an experimental doxygen build option which attempts to build clamav.h and libfreshclam doxygen html docs. The CMake build tooling also may build the example program(s), which isn't a feature in the Autotools build system. Changed C standard to C90+ due to inline linking issues with socket.h when linking libfreshclam.so on Linux. Generate common.rc for win32. Fix tabs/spaces in shared Makefile.am, and remove vestigial ifndef from misc.c. Add CMake files to the automake dist, so users can try the new CMake tooling w/out having to build from a git clone. clamonacc changes: - Renamed FANOTIFY macro to HAVE_SYS_FANOTIFY_H to better match other similar macros. - Added a new clamav-clamonacc.service systemd unit file, based on the work of ChadDevOps & Aaron Brighton. - Added missing clamonacc man page. Updates to clamdscan man page, add missing options. Remove vestigial CL_NOLIBCLAMAV definitions (all apps now use libclamav). Rename Windows mspack.dll to libmspack.dll so all ClamAV-built libraries have the lib-prefix with Visual Studio as with CMake.	5 years ago