From 7acea882993e1dac4a62109f3acb58936ed2f3b8 Mon Sep 17 00:00:00 2001 From: Jonas Zaddach Date: Thu, 19 Nov 2020 22:39:11 +0100 Subject: [PATCH 01/26] clamav-sys: Initial repo --- .gitignore | 2 + Cargo.toml | 14 +++ LICENSE | 339 +++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 19 +++ build.rs | 100 ++++++++++++++++ src/lib.rs | 52 ++++++++ wrapper.h | 1 + 7 files changed, 527 insertions(+) create mode 100644 .gitignore create mode 100644 Cargo.toml create mode 100644 LICENSE create mode 100644 README.md create mode 100644 build.rs create mode 100644 src/lib.rs create mode 100644 wrapper.h diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000..96ef6c0b94 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/target +Cargo.lock diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000000..80b3f63611 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,14 @@ +[package] +name = "clamav-sys" +description = "ClamAV low level bindings for Rust" +version = "0.0.1" +authors = ["Jonas Zaddach "] +edition = "2018" +license = "GPL-2.0" +categories = ["external-ffi-bindings"] +homepage = "https://github.com/zaddach/clamav-sys/" +repository = "https://github.com/zaddach/clamav-sys/" + +[build-dependencies] +pkg-config = "0.3" +bindgen = "0.53.1" diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000..d159169d10 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/README.md b/README.md new file mode 100644 index 0000000000..5842cd3ae4 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# clamav-sys + +clamav-sys is a minimal Rust interface around libclamav](https://www.clamav.net). +This package is not supposed to be used stand-alone, but only through its safe wrapper, +clamav-rs. + + +## Building + +### Unix (anything but Windows) +You should have the `clamav-dev` package of your distribution installed (ClamAV +with headers). The headers and library should be picked up automatically. + +### Windows +You will need to define the following environment variables: +- `CLAMAV_SOURCE`: Points to the directory where the ClamAV source is located. +- `CLAMAV_BUILD`: Points to the ClamAV build directory. +- `OPENSSL_INCLUDE`: Points to the include directory containing `openssl/ssl.h`. + diff --git a/build.rs b/build.rs new file mode 100644 index 0000000000..ea16985a18 --- /dev/null +++ b/build.rs @@ -0,0 +1,100 @@ +// +// Copyright (C) 2020 Jonas Zaddach. +// +// This program is free software; you can redistribute it and/or modify +// it under the terms of the GNU General Public License version 2 as +// published by the Free Software Foundation. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program; if not, write to the Free Software +// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +// MA 02110-1301, USA. + +use std::path::{PathBuf, Path}; +use std::env; + +fn main() { + println!("cargo:rustc-link-lib=dylib={}", "clamav"); + if cfg!(windows) { + let clamav_build = env::var("CLAMAV_BUILD").expect("CLAMAV_BUILD environment variable must be set and point to ClamAV's build directory"); + let profile = env::var("PROFILE").unwrap(); + + let library_path = match profile.as_str() { + "debug" => Path::new(&clamav_build).join("libclamav/Debug"), + "release" => Path::new(&clamav_build).join("libclamav/Release"), + _ => panic!("Unexpected build profile"), + }; + + println!("cargo:rustc-link-search=native={}", library_path.to_str().unwrap()); + } + else { + pkg_config::Config::new() + .atleast_version("0.102") + .probe("libclamav") + .unwrap(); + } + + // Tell cargo to invalidate the built crate whenever the wrapper changes + println!("cargo:rerun-if-changed=wrapper.h"); + + // The bindgen::Builder is the main entry point + // to bindgen, and lets you build up options for + // the resulting bindings. + let mut bindings = bindgen::Builder::default() + // The input header we would like to generate + // bindings for. + //Whitelist wanted functions + .whitelist_function("cl_init") + .whitelist_function("cl_initialize_crypto") + .whitelist_function("cl_cleanup_crypto") + .whitelist_function("cl_strerror") + .whitelist_function("cl_engine_new") + .whitelist_function("cl_engine_free") + .whitelist_function("cl_engine_compile") + .whitelist_function("cl_scandesc") + .whitelist_function("cl_scanmap_callback") + .whitelist_function("cl_fmap_open_memory") + .whitelist_function("cl_fmap_close") + .whitelist_function("cl_retflevel") + .whitelist_function("cl_retver") + .whitelist_function("cl_load") + .whitelist_function("cl_scanfile") + .whitelist_function("cl_retdbdir") + .rustified_enum("cl_error_t") + //Whitelist wanted constants + .whitelist_var("CL_SCAN_.*") + .whitelist_var("CL_INIT_DEFAULT") + .whitelist_var("CL_DB_.*") + + .header("wrapper.h") + + // Tell cargo to invalidate the built crate whenever any of the + // included header files changed. + .parse_callbacks(Box::new(bindgen::CargoCallbacks)); + + if cfg!(windows) { + let clamav_source = PathBuf::from(env::var("CLAMAV_SOURCE").expect("CLAMAV_SOURCE environment variable must be set and point to ClamAV's source directory")); + let clamav_build = PathBuf::from(env::var("CLAMAV_BUILD").expect("CLAMAV_BUILD environment variable must be set and point to ClamAV's build directory")); + let openssl_include = PathBuf::from(env::var("OPENSSL_INCLUDE").expect("OPENSSL_INCLUDE environment variable must be set and point to openssl's include directory")); + bindings = bindings + .clang_arg("-I") .clang_arg(clamav_source.join("libclamav").to_str().unwrap()) + .clang_arg("-I") .clang_arg(clamav_build.to_str().unwrap()) + .clang_arg("-I") .clang_arg(openssl_include.to_str().unwrap()) + } + + // Write the bindings to the $OUT_DIR/bindings.rs file. + let out_path = PathBuf::from(env::var("OUT_DIR").unwrap()); + + bindings + // Finish the builder and generate the bindings. + .generate() + // Unwrap the Result and panic on failure. + .expect("Unable to generate bindings") + .write_to_file(out_path.join("bindings.rs")) + .expect("Couldn't write bindings!"); +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000000..900b14e5e2 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,52 @@ +// +// Copyright (C) 2020 Jonas Zaddach. +// +// This program is free software; you can redistribute it and/or modify +// it under the terms of the GNU General Public License version 2 as +// published by the Free Software Foundation. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program; if not, write to the Free Software +// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +// MA 02110-1301, USA. + +#![allow(non_camel_case_types, non_upper_case_globals)] + +include!(concat!(env!("OUT_DIR"), "/bindings.rs")); + + +impl Default for cl_scan_options { + fn default() -> Self { + cl_scan_options { + general: 0, + parse: CL_SCAN_PARSE_ARCHIVE + | CL_SCAN_PARSE_MAIL + | CL_SCAN_PARSE_OLE2 + | CL_SCAN_PARSE_PDF + | CL_SCAN_PARSE_HTML + | CL_SCAN_PARSE_SWF + | CL_SCAN_PARSE_PE + | CL_SCAN_PARSE_ELF + | CL_SCAN_PARSE_SWF + | CL_SCAN_PARSE_XMLDOCS, + heuristic: 0, + mail: 0, + dev: 0, + } + } +} + +impl PartialEq for cl_scan_options { + fn eq(& self, other: &Self) -> bool { + self.general == other.general && + self.parse == other.parse && + self.heuristic == other.heuristic && + self.mail == other.mail && + self.dev == other.dev + } +} diff --git a/wrapper.h b/wrapper.h new file mode 100644 index 0000000000..9f0a279db8 --- /dev/null +++ b/wrapper.h @@ -0,0 +1 @@ +#include From 64ec98f2c4d9170d4cb2dccedaa2064d4584fb76 Mon Sep 17 00:00:00 2001 From: Jonas Zaddach Date: Mon, 23 Nov 2020 18:05:53 +0100 Subject: [PATCH 02/26] clamav-sys: Add vcpkg support --- Cargo.toml | 3 +- README.md | 11 +++++++ build.rs | 85 ++++++++++++++++++++++++++++++++---------------------- 3 files changed, 63 insertions(+), 36 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 80b3f63611..58545629b8 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "clamav-sys" description = "ClamAV low level bindings for Rust" -version = "0.0.1" +version = "0.0.2" authors = ["Jonas Zaddach "] edition = "2018" license = "GPL-2.0" @@ -12,3 +12,4 @@ repository = "https://github.com/zaddach/clamav-sys/" [build-dependencies] pkg-config = "0.3" bindgen = "0.53.1" +vcpkg = "0.2.10" diff --git a/README.md b/README.md index 5842cd3ae4..9e2dd6d5a5 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,17 @@ You should have the `clamav-dev` package of your distribution installed (ClamAV with headers). The headers and library should be picked up automatically. ### Windows +#### vcpkg +The preferred way of handling dependencies is `vcpkg`. +Point `$env:VCPKG_ROOT` to your `vcpkg` installation, and set +`$env:VCPKGRS_DYNAMIC=1` to use dynamic linking (the default method of linking will +likely not work, as `pdcurses` doesn't support the `x64-windows-static-md` triplet). + +See the [vcpkg crate's documentation](https://docs.rs/vcpkg) for more details. + +#### Manual +If `vcpkg` is not available or cannot be found on your system, the build defaults +to a manual specification of dependencies. You will need to define the following environment variables: - `CLAMAV_SOURCE`: Points to the directory where the ClamAV source is located. - `CLAMAV_BUILD`: Points to the ClamAV build directory. diff --git a/build.rs b/build.rs index ea16985a18..0e99b3bcd7 100644 --- a/build.rs +++ b/build.rs @@ -18,33 +18,8 @@ use std::path::{PathBuf, Path}; use std::env; -fn main() { - println!("cargo:rustc-link-lib=dylib={}", "clamav"); - if cfg!(windows) { - let clamav_build = env::var("CLAMAV_BUILD").expect("CLAMAV_BUILD environment variable must be set and point to ClamAV's build directory"); - let profile = env::var("PROFILE").unwrap(); - - let library_path = match profile.as_str() { - "debug" => Path::new(&clamav_build).join("libclamav/Debug"), - "release" => Path::new(&clamav_build).join("libclamav/Release"), - _ => panic!("Unexpected build profile"), - }; - - println!("cargo:rustc-link-search=native={}", library_path.to_str().unwrap()); - } - else { - pkg_config::Config::new() - .atleast_version("0.102") - .probe("libclamav") - .unwrap(); - } - // Tell cargo to invalidate the built crate whenever the wrapper changes - println!("cargo:rerun-if-changed=wrapper.h"); - - // The bindgen::Builder is the main entry point - // to bindgen, and lets you build up options for - // the resulting bindings. +fn generate_bindings(customize_bindings: &dyn Fn(bindgen::Builder) -> bindgen::Builder) { let mut bindings = bindgen::Builder::default() // The input header we would like to generate // bindings for. @@ -77,15 +52,7 @@ fn main() { // included header files changed. .parse_callbacks(Box::new(bindgen::CargoCallbacks)); - if cfg!(windows) { - let clamav_source = PathBuf::from(env::var("CLAMAV_SOURCE").expect("CLAMAV_SOURCE environment variable must be set and point to ClamAV's source directory")); - let clamav_build = PathBuf::from(env::var("CLAMAV_BUILD").expect("CLAMAV_BUILD environment variable must be set and point to ClamAV's build directory")); - let openssl_include = PathBuf::from(env::var("OPENSSL_INCLUDE").expect("OPENSSL_INCLUDE environment variable must be set and point to openssl's include directory")); - bindings = bindings - .clang_arg("-I") .clang_arg(clamav_source.join("libclamav").to_str().unwrap()) - .clang_arg("-I") .clang_arg(clamav_build.to_str().unwrap()) - .clang_arg("-I") .clang_arg(openssl_include.to_str().unwrap()) - } + bindings = customize_bindings(bindings); // Write the bindings to the $OUT_DIR/bindings.rs file. let out_path = PathBuf::from(env::var("OUT_DIR").unwrap()); @@ -98,3 +65,51 @@ fn main() { .write_to_file(out_path.join("bindings.rs")) .expect("Couldn't write bindings!"); } + +fn cargo_common() { + println!("cargo:rustc-link-lib=dylib={}", "clamav"); + + // Tell cargo to invalidate the built crate whenever the wrapper changes + println!("cargo:rerun-if-changed=wrapper.h"); +} + + + +#[cfg(windows)] +fn main() { + let include_paths = match vcpkg::find_package("clamav") { + Ok(pkg) => pkg.include_paths, + Err(err) => { + println!("cargo:warning=Either vcpkg is not installed, or an error occurred in vcpkg: {}", err); + let clamav_source = PathBuf::from(env::var("CLAMAV_SOURCE").expect("CLAMAV_SOURCE environment variable must be set and point to ClamAV's source directory")); + let clamav_build = PathBuf::from(env::var("CLAMAV_BUILD").expect("CLAMAV_BUILD environment variable must be set and point to ClamAV's build directory")); + let openssl_include = PathBuf::from(env::var("OPENSSL_INCLUDE").expect("OPENSSL_INCLUDE environment variable must be set and point to openssl's include directory")); + let profile = env::var("PROFILE").unwrap(); + + let library_path = match profile.as_str() { + "debug" => Path::new(&clamav_build).join("libclamav/Debug"), + "release" => Path::new(&clamav_build).join("libclamav/Release"), + _ => panic!("Unexpected build profile"), + }; + + println!("cargo:rustc-link-search=native={}", library_path.to_str().unwrap()); + + vec![clamav_source.join("libclamav"), clamav_build, openssl_include] + } + }; + + cargo_common(); + generate_bindings(&|x: bindgen::Builder| -> bindgen::Builder {let mut x = x; for include_path in &include_paths {x = x.clang_arg("-I").clang_arg(include_path.to_str().unwrap());}; x}); +} + +#[cfg(unix)] +fn main() { + pkg_config::Config::new() + .atleast_version("0.102") + .probe("libclamav") + .unwrap(); + + cargo_common(); + generate_bindings(&|x| x); +} + From 2fad71fe94de15689e41b345067998d809494bec Mon Sep 17 00:00:00 2001 From: Micah Snyder <30635813+micahsnyder@users.noreply.github.com> Date: Mon, 30 Nov 2020 11:06:59 -0800 Subject: [PATCH 03/26] clamav-sys: Fix link in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9e2dd6d5a5..5ee6668937 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # clamav-sys -clamav-sys is a minimal Rust interface around libclamav](https://www.clamav.net). +clamav-sys is a minimal Rust interface around [libclamav](https://www.clamav.net). This package is not supposed to be used stand-alone, but only through its safe wrapper, clamav-rs. From 038a8706456a0fb13827489594814301b5e2cd32 Mon Sep 17 00:00:00 2001 From: Jonas Zaddach Date: Fri, 22 Jan 2021 18:23:47 +0000 Subject: [PATCH 04/26] clamav-sys: Build errors with ClamAV 0.102, bumped requirement to 0.103 --- Cargo.toml | 8 ++++++-- build.rs | 6 ++++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 58545629b8..1ae5462347 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "clamav-sys" description = "ClamAV low level bindings for Rust" -version = "0.0.2" +version = "0.0.3" authors = ["Jonas Zaddach "] edition = "2018" license = "GPL-2.0" @@ -10,6 +10,10 @@ homepage = "https://github.com/zaddach/clamav-sys/" repository = "https://github.com/zaddach/clamav-sys/" [build-dependencies] +bindgen = "0.56.0" + +[target.'cfg(unix)'.build-dependencies] pkg-config = "0.3" -bindgen = "0.53.1" + +[target.'cfg(windows)'.build-dependencies] vcpkg = "0.2.10" diff --git a/build.rs b/build.rs index 0e99b3bcd7..7839ce348a 100644 --- a/build.rs +++ b/build.rs @@ -15,7 +15,7 @@ // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, // MA 02110-1301, USA. -use std::path::{PathBuf, Path}; +use std::path::PathBuf; use std::env; @@ -40,12 +40,14 @@ fn generate_bindings(customize_bindings: &dyn Fn(bindgen::Builder) -> bindgen::B .whitelist_function("cl_load") .whitelist_function("cl_scanfile") .whitelist_function("cl_retdbdir") + //Whitelist wanted types .rustified_enum("cl_error_t") //Whitelist wanted constants .whitelist_var("CL_SCAN_.*") .whitelist_var("CL_INIT_DEFAULT") .whitelist_var("CL_DB_.*") + .header("wrapper.h") // Tell cargo to invalidate the built crate whenever any of the @@ -105,7 +107,7 @@ fn main() { #[cfg(unix)] fn main() { pkg_config::Config::new() - .atleast_version("0.102") + .atleast_version("0.103") .probe("libclamav") .unwrap(); From 8c4bf60597dc78b6471124a9a7520b09a52f49ab Mon Sep 17 00:00:00 2001 From: Jonas Zaddach Date: Mon, 26 Apr 2021 23:39:12 +0200 Subject: [PATCH 05/26] clamav-sys: Fixes for building on MacOS --- build.rs | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/build.rs b/build.rs index 7839ce348a..0d524c3537 100644 --- a/build.rs +++ b/build.rs @@ -106,12 +106,20 @@ fn main() { #[cfg(unix)] fn main() { - pkg_config::Config::new() + let libclamav = pkg_config::Config::new() .atleast_version("0.103") .probe("libclamav") .unwrap(); + let mut include_paths = libclamav.include_paths.clone(); + + if let Some(val) = std::env::var_os("OPENSSL_ROOT_DIR") { + let mut openssl_include_dir = PathBuf::from(val); + openssl_include_dir.push("include"); + include_paths.push(openssl_include_dir); + } + cargo_common(); - generate_bindings(&|x| x); + generate_bindings(&|x: bindgen::Builder| -> bindgen::Builder {let mut x = x; for include_path in &include_paths {x = x.clang_arg("-I").clang_arg(include_path.to_str().unwrap());}; x}); } From b82c9bdb6fcd1782aa27914a3fda34f78459c8c5 Mon Sep 17 00:00:00 2001 From: Jonas Zaddach Date: Mon, 25 Jan 2021 09:45:10 +0100 Subject: [PATCH 06/26] clamav-sys: Fixed Path import on Windows --- build.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/build.rs b/build.rs index 0d524c3537..339ff9df2a 100644 --- a/build.rs +++ b/build.rs @@ -89,8 +89,8 @@ fn main() { let profile = env::var("PROFILE").unwrap(); let library_path = match profile.as_str() { - "debug" => Path::new(&clamav_build).join("libclamav/Debug"), - "release" => Path::new(&clamav_build).join("libclamav/Release"), + "debug" => std::path::Path::new(&clamav_build).join("libclamav/Debug"), + "release" => std::path::Path::new(&clamav_build).join("libclamav/Release"), _ => panic!("Unexpected build profile"), }; From a49d62fbd381755d39ca9df8170f07f166bc6da9 Mon Sep 17 00:00:00 2001 From: Jonas Zaddach Date: Mon, 8 Feb 2021 13:52:30 +0100 Subject: [PATCH 07/26] clamav-sys: Added cl_fmap_open_handle function --- build.rs | 1 + 1 file changed, 1 insertion(+) diff --git a/build.rs b/build.rs index 339ff9df2a..eface637ec 100644 --- a/build.rs +++ b/build.rs @@ -33,6 +33,7 @@ fn generate_bindings(customize_bindings: &dyn Fn(bindgen::Builder) -> bindgen::B .whitelist_function("cl_engine_compile") .whitelist_function("cl_scandesc") .whitelist_function("cl_scanmap_callback") + .whitelist_function("cl_fmap_open_handle") .whitelist_function("cl_fmap_open_memory") .whitelist_function("cl_fmap_close") .whitelist_function("cl_retflevel") From 2c8561fd9dec59633a38951d0c56cf0f97e2bed6 Mon Sep 17 00:00:00 2001 From: Jonas Zaddach Date: Fri, 21 May 2021 19:26:55 +0200 Subject: [PATCH 08/26] clamav-sys: Increase version number --- Cargo.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 1ae5462347..3c644d15b2 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "clamav-sys" description = "ClamAV low level bindings for Rust" -version = "0.0.3" +version = "0.0.4" authors = ["Jonas Zaddach "] edition = "2018" license = "GPL-2.0" From c046b5bf544af040c92a4f3484136cc8f258fb49 Mon Sep 17 00:00:00 2001 From: Jonas Zaddach Date: Mon, 24 May 2021 11:41:06 +0200 Subject: [PATCH 09/26] clamav-sys: Added build instructions for MacOS --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5ee6668937..2b8dac0164 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,8 @@ clamav-rs. ### Unix (anything but Windows) You should have the `clamav-dev` package of your distribution installed (ClamAV -with headers). The headers and library should be picked up automatically. +with headers). The headers and library should be picked up automatically via +pkg-config. ### Windows #### vcpkg @@ -28,3 +29,14 @@ You will need to define the following environment variables: - `CLAMAV_BUILD`: Points to the ClamAV build directory. - `OPENSSL_INCLUDE`: Points to the include directory containing `openssl/ssl.h`. +### MacOS +Install the development dependencies via `homebrew`: +``` +brew install clamav openssl@1.1 +``` + +OpenSSL is not included in the environment to avoid shadowing Apple's one, so +you need to tell the build script where it is located: +``` +export OPENSSL_ROOT_DIR=/usr/local/Cellar/openssl@1.1/1.1.1i/ +``` From 8fbf6ca6f8b709673db5cda23f6868fcfd7fc23e Mon Sep 17 00:00:00 2001 From: Jonas Zaddach Date: Mon, 24 May 2021 13:03:13 +0200 Subject: [PATCH 10/26] clamav-sys: Documented PowerShell library conflict gotcha --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 2b8dac0164..70a60d5832 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,19 @@ likely not work, as `pdcurses` doesn't support the `x64-windows-static-md` tripl See the [vcpkg crate's documentation](https://docs.rs/vcpkg) for more details. +Gotchas: +- Windows has its own version of a zlib dll that is incompatbile with vcpkg. If + you get a message such as "The procedure entry point gzdirect could not be + located in the dynamic link library", you'll want to make sure that the vcpkg + dynamic libraries in your PATH variable are preceding the Windows one. + ``` + $env:PATH="$env:VCPKG_ROOT\installed\x64-windows\bin\;$env:PATH" + ``` + This error is especially hard to diagnose in PowerShell, as the process will + just hang without any output. In cmd.exe you'll get the aforementioned dialog + box telling you about the error. + + #### Manual If `vcpkg` is not available or cannot be found on your system, the build defaults to a manual specification of dependencies. From ceb6693bc7620ec0b5a2b6aea5116aaefe0f71a1 Mon Sep 17 00:00:00 2001 From: Jonas Zaddach Date: Mon, 31 May 2021 13:20:54 +0200 Subject: [PATCH 11/26] clamav-sys: Added functions to get/set engine fields --- build.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/build.rs b/build.rs index eface637ec..573df9cae1 100644 --- a/build.rs +++ b/build.rs @@ -31,6 +31,10 @@ fn generate_bindings(customize_bindings: &dyn Fn(bindgen::Builder) -> bindgen::B .whitelist_function("cl_engine_new") .whitelist_function("cl_engine_free") .whitelist_function("cl_engine_compile") + .whitelist_function("cl_engine_get_num") + .whitelist_function("cl_engine_set_num") + .whitelist_function("cl_engine_get_str") + .whitelist_function("cl_engine_set_str") .whitelist_function("cl_scandesc") .whitelist_function("cl_scanmap_callback") .whitelist_function("cl_fmap_open_handle") @@ -43,6 +47,8 @@ fn generate_bindings(customize_bindings: &dyn Fn(bindgen::Builder) -> bindgen::B .whitelist_function("cl_retdbdir") //Whitelist wanted types .rustified_enum("cl_error_t") + .rustified_enum("cl_engine_field") + .whitelist_type("time_t") //Whitelist wanted constants .whitelist_var("CL_SCAN_.*") .whitelist_var("CL_INIT_DEFAULT") From 00065662dc4cce9afbe2d7e178a8606ab7fe43d6 Mon Sep 17 00:00:00 2001 From: Jonas Zaddach Date: Mon, 31 May 2021 13:21:39 +0200 Subject: [PATCH 12/26] clamav-sys: Bumped version --- Cargo.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 3c644d15b2..848368c2bb 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "clamav-sys" description = "ClamAV low level bindings for Rust" -version = "0.0.4" +version = "0.0.5" authors = ["Jonas Zaddach "] edition = "2018" license = "GPL-2.0" From 48c1479432e2c238980e59d6168471cd2121b00a Mon Sep 17 00:00:00 2001 From: Scott Hutton Date: Tue, 18 Oct 2022 11:27:03 -0700 Subject: [PATCH 13/26] clamav-sys: Reformat --- Cargo.toml | 10 +++++----- build.rs | 41 ++++++++++++++++++++++++++++------------- src/lib.rs | 41 ++++++++++++++++++++--------------------- 3 files changed, 53 insertions(+), 39 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 848368c2bb..0da80e3c30 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,13 +1,13 @@ [package] -name = "clamav-sys" -description = "ClamAV low level bindings for Rust" -version = "0.0.5" authors = ["Jonas Zaddach "] -edition = "2018" -license = "GPL-2.0" categories = ["external-ffi-bindings"] +description = "ClamAV low level bindings for Rust" +edition = "2018" homepage = "https://github.com/zaddach/clamav-sys/" +license = "GPL-2.0" +name = "clamav-sys" repository = "https://github.com/zaddach/clamav-sys/" +version = "0.0.5" [build-dependencies] bindgen = "0.56.0" diff --git a/build.rs b/build.rs index 573df9cae1..c99e0d032b 100644 --- a/build.rs +++ b/build.rs @@ -15,9 +15,8 @@ // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, // MA 02110-1301, USA. -use std::path::PathBuf; use std::env; - +use std::path::PathBuf; fn generate_bindings(customize_bindings: &dyn Fn(bindgen::Builder) -> bindgen::Builder) { let mut bindings = bindgen::Builder::default() @@ -53,10 +52,7 @@ fn generate_bindings(customize_bindings: &dyn Fn(bindgen::Builder) -> bindgen::B .whitelist_var("CL_SCAN_.*") .whitelist_var("CL_INIT_DEFAULT") .whitelist_var("CL_DB_.*") - - .header("wrapper.h") - // Tell cargo to invalidate the built crate whenever any of the // included header files changed. .parse_callbacks(Box::new(bindgen::CargoCallbacks)); @@ -82,14 +78,15 @@ fn cargo_common() { println!("cargo:rerun-if-changed=wrapper.h"); } - - #[cfg(windows)] fn main() { let include_paths = match vcpkg::find_package("clamav") { Ok(pkg) => pkg.include_paths, Err(err) => { - println!("cargo:warning=Either vcpkg is not installed, or an error occurred in vcpkg: {}", err); + println!( + "cargo:warning=Either vcpkg is not installed, or an error occurred in vcpkg: {}", + err + ); let clamav_source = PathBuf::from(env::var("CLAMAV_SOURCE").expect("CLAMAV_SOURCE environment variable must be set and point to ClamAV's source directory")); let clamav_build = PathBuf::from(env::var("CLAMAV_BUILD").expect("CLAMAV_BUILD environment variable must be set and point to ClamAV's build directory")); let openssl_include = PathBuf::from(env::var("OPENSSL_INCLUDE").expect("OPENSSL_INCLUDE environment variable must be set and point to openssl's include directory")); @@ -101,14 +98,27 @@ fn main() { _ => panic!("Unexpected build profile"), }; - println!("cargo:rustc-link-search=native={}", library_path.to_str().unwrap()); + println!( + "cargo:rustc-link-search=native={}", + library_path.to_str().unwrap() + ); - vec![clamav_source.join("libclamav"), clamav_build, openssl_include] + vec![ + clamav_source.join("libclamav"), + clamav_build, + openssl_include, + ] } }; cargo_common(); - generate_bindings(&|x: bindgen::Builder| -> bindgen::Builder {let mut x = x; for include_path in &include_paths {x = x.clang_arg("-I").clang_arg(include_path.to_str().unwrap());}; x}); + generate_bindings(&|x: bindgen::Builder| -> bindgen::Builder { + let mut x = x; + for include_path in &include_paths { + x = x.clang_arg("-I").clang_arg(include_path.to_str().unwrap()); + } + x + }); } #[cfg(unix)] @@ -127,6 +137,11 @@ fn main() { } cargo_common(); - generate_bindings(&|x: bindgen::Builder| -> bindgen::Builder {let mut x = x; for include_path in &include_paths {x = x.clang_arg("-I").clang_arg(include_path.to_str().unwrap());}; x}); + generate_bindings(&|x: bindgen::Builder| -> bindgen::Builder { + let mut x = x; + for include_path in &include_paths { + x = x.clang_arg("-I").clang_arg(include_path.to_str().unwrap()); + } + x + }); } - diff --git a/src/lib.rs b/src/lib.rs index 900b14e5e2..ae3069cf7a 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -19,34 +19,33 @@ include!(concat!(env!("OUT_DIR"), "/bindings.rs")); - impl Default for cl_scan_options { fn default() -> Self { cl_scan_options { general: 0, - parse: CL_SCAN_PARSE_ARCHIVE - | CL_SCAN_PARSE_MAIL - | CL_SCAN_PARSE_OLE2 - | CL_SCAN_PARSE_PDF - | CL_SCAN_PARSE_HTML - | CL_SCAN_PARSE_SWF - | CL_SCAN_PARSE_PE - | CL_SCAN_PARSE_ELF - | CL_SCAN_PARSE_SWF - | CL_SCAN_PARSE_XMLDOCS, - heuristic: 0, - mail: 0, - dev: 0, - } + parse: CL_SCAN_PARSE_ARCHIVE + | CL_SCAN_PARSE_MAIL + | CL_SCAN_PARSE_OLE2 + | CL_SCAN_PARSE_PDF + | CL_SCAN_PARSE_HTML + | CL_SCAN_PARSE_SWF + | CL_SCAN_PARSE_PE + | CL_SCAN_PARSE_ELF + | CL_SCAN_PARSE_SWF + | CL_SCAN_PARSE_XMLDOCS, + heuristic: 0, + mail: 0, + dev: 0, + } } } impl PartialEq for cl_scan_options { - fn eq(& self, other: &Self) -> bool { - self.general == other.general && - self.parse == other.parse && - self.heuristic == other.heuristic && - self.mail == other.mail && - self.dev == other.dev + fn eq(&self, other: &Self) -> bool { + self.general == other.general + && self.parse == other.parse + && self.heuristic == other.heuristic + && self.mail == other.mail + && self.dev == other.dev } } From 70d2c2881163d22b6c8d39fbda4b9430c24ddd12 Mon Sep 17 00:00:00 2001 From: Scott Hutton Date: Wed, 19 Oct 2022 09:03:36 -0700 Subject: [PATCH 14/26] clamav-sys: Sort whitelisted API elements by type and name --- build.rs | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/build.rs b/build.rs index c99e0d032b..7924c66d61 100644 --- a/build.rs +++ b/build.rs @@ -23,35 +23,35 @@ fn generate_bindings(customize_bindings: &dyn Fn(bindgen::Builder) -> bindgen::B // The input header we would like to generate // bindings for. //Whitelist wanted functions - .whitelist_function("cl_init") - .whitelist_function("cl_initialize_crypto") .whitelist_function("cl_cleanup_crypto") - .whitelist_function("cl_strerror") - .whitelist_function("cl_engine_new") - .whitelist_function("cl_engine_free") .whitelist_function("cl_engine_compile") + .whitelist_function("cl_engine_free") .whitelist_function("cl_engine_get_num") - .whitelist_function("cl_engine_set_num") .whitelist_function("cl_engine_get_str") + .whitelist_function("cl_engine_new") + .whitelist_function("cl_engine_set_num") .whitelist_function("cl_engine_set_str") - .whitelist_function("cl_scandesc") - .whitelist_function("cl_scanmap_callback") + .whitelist_function("cl_fmap_close") .whitelist_function("cl_fmap_open_handle") .whitelist_function("cl_fmap_open_memory") - .whitelist_function("cl_fmap_close") + .whitelist_function("cl_init") + .whitelist_function("cl_initialize_crypto") + .whitelist_function("cl_load") + .whitelist_function("cl_retdbdir") .whitelist_function("cl_retflevel") .whitelist_function("cl_retver") - .whitelist_function("cl_load") + .whitelist_function("cl_scandesc") .whitelist_function("cl_scanfile") - .whitelist_function("cl_retdbdir") + .whitelist_function("cl_scanmap_callback") + .whitelist_function("cl_strerror") //Whitelist wanted types - .rustified_enum("cl_error_t") .rustified_enum("cl_engine_field") + .rustified_enum("cl_error_t") .whitelist_type("time_t") //Whitelist wanted constants - .whitelist_var("CL_SCAN_.*") - .whitelist_var("CL_INIT_DEFAULT") .whitelist_var("CL_DB_.*") + .whitelist_var("CL_INIT_DEFAULT") + .whitelist_var("CL_SCAN_.*") .header("wrapper.h") // Tell cargo to invalidate the built crate whenever any of the // included header files changed. From 9a08e9cf80a17a8e35df0f4910559ec60155f65c Mon Sep 17 00:00:00 2001 From: Scott Hutton Date: Tue, 18 Oct 2022 11:30:57 -0700 Subject: [PATCH 15/26] clamav-sys: Expose cl_set_clcb_msg and cl_msg --- build.rs | 2 ++ src/lib.rs | 14 ++++++++++++++ 2 files changed, 16 insertions(+) diff --git a/build.rs b/build.rs index 7924c66d61..e428c4b7d7 100644 --- a/build.rs +++ b/build.rs @@ -43,10 +43,12 @@ fn generate_bindings(customize_bindings: &dyn Fn(bindgen::Builder) -> bindgen::B .whitelist_function("cl_scandesc") .whitelist_function("cl_scanfile") .whitelist_function("cl_scanmap_callback") + .whitelist_function("cl_set_clcb_msg") .whitelist_function("cl_strerror") //Whitelist wanted types .rustified_enum("cl_engine_field") .rustified_enum("cl_error_t") + .rustified_enum("cl_msg") .whitelist_type("time_t") //Whitelist wanted constants .whitelist_var("CL_DB_.*") diff --git a/src/lib.rs b/src/lib.rs index ae3069cf7a..210990b870 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -49,3 +49,17 @@ impl PartialEq for cl_scan_options { && self.dev == other.dev } } + +#[cfg(test)] +mod tests { + use super::cl_msg; + + #[test] + fn msg_levels_exist() { + // Just a compilation check that the message levels are there. We don't + // check their values since those are defined in the C header file. + assert!(cl_msg::CL_MSG_WARN as isize != 0); + assert!(cl_msg::CL_MSG_ERROR as isize != 0); + assert!(cl_msg::CL_MSG_INFO_VERBOSE as isize != 0); + } +} From 5aa265bd6f161b97af164e857ccce57d6efd678e Mon Sep 17 00:00:00 2001 From: Scott Hutton Date: Mon, 6 Nov 2023 15:00:59 -0800 Subject: [PATCH 16/26] clamav-sys: Extended API exposure and newtype enums * Switch to "newtype" enums * Exposed: - cl_set_clcb_msg() - cl_cvdparse() and supporting symbols - cl_debug() - DB load/progress callback setting functions - engine scan callbacks and types - File file inspection callbacks and types * Moved allowlisted funcs/types/variables to constants * Updated bindgen dependency --- Cargo.toml | 6 +-- README.md | 9 ++++ build.rs | 150 ++++++++++++++++++++++++++++++++++++++++------------- src/lib.rs | 113 ++++++++++++++++++++++++++++++++++++++-- 4 files changed, 235 insertions(+), 43 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 0da80e3c30..b861036c36 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,15 +2,15 @@ authors = ["Jonas Zaddach "] categories = ["external-ffi-bindings"] description = "ClamAV low level bindings for Rust" -edition = "2018" +edition = "2021" homepage = "https://github.com/zaddach/clamav-sys/" license = "GPL-2.0" name = "clamav-sys" repository = "https://github.com/zaddach/clamav-sys/" -version = "0.0.5" +version = "1.0.0" [build-dependencies] -bindgen = "0.56.0" +bindgen = "0.64.0" [target.'cfg(unix)'.build-dependencies] pkg-config = "0.3" diff --git a/README.md b/README.md index 70a60d5832..869cff4ed0 100644 --- a/README.md +++ b/README.md @@ -53,3 +53,12 @@ you need to tell the build script where it is located: ``` export OPENSSL_ROOT_DIR=/usr/local/Cellar/openssl@1.1/1.1.1i/ ``` + +## Versioning +The version number of `libclamav-sys` tracks ClamAV's version number. That is, +you'll require at least ClamAV 1.0.0 to build `libclamav-sys` 1.0.0. As ClamAV +usually doesn't do breaking API changes, you'll be able to use `libclamav-sys` +with newer ClamAV versions. + +No attempt at preserving downward compatibility (using a `libclamav-sys` with +a version number greater than ClamAV's) is made. diff --git a/build.rs b/build.rs index e428c4b7d7..a6d1e9204d 100644 --- a/build.rs +++ b/build.rs @@ -18,42 +18,118 @@ use std::env; use std::path::PathBuf; +// Generate bindings for these functions: +const BINDGEN_FUNCTIONS: &[&str] = &[ + "cl_cleanup_crypto", + "cl_cvdfree", + "cl_cvdparse", + "cl_debug", + "cl_engine_addref", + "cl_engine_compile", + "cl_engine_free", + "cl_engine_get_num", + "cl_engine_get_str", + "cl_engine_new", + "cl_engine_set_clcb_engine_compile_progress", + "cl_engine_set_clcb_engine_free_progress", + "cl_engine_set_clcb_file_inspection", + "cl_engine_set_clcb_file_props", + "cl_engine_set_clcb_hash", + "cl_engine_set_clcb_meta", + "cl_engine_set_clcb_post_scan", + "cl_engine_set_clcb_pre_cache", + "cl_engine_set_clcb_pre_scan", + "cl_engine_set_clcb_sigload", + "cl_engine_set_clcb_sigload_progress", + "cl_engine_set_clcb_stats_add_sample", + "cl_engine_set_clcb_stats_decrement_count", + "cl_engine_set_clcb_stats_flush", + "cl_engine_set_clcb_stats_get_hostid", + "cl_engine_set_clcb_stats_get_num", + "cl_engine_set_clcb_stats_get_size", + "cl_engine_set_clcb_stats_remove_sample", + "cl_engine_set_clcb_stats_submit", + "cl_engine_set_clcb_virus_found", + "cl_engine_set_num", + "cl_engine_set_stats_set_cbdata", + "cl_engine_set_str", + "cl_engine_settings_apply", + "cl_engine_settings_copy", + "cl_engine_settings_free", + "cl_engine_stats_enable", + "cl_fmap_close", + "cl_fmap_open_handle", + "cl_fmap_open_memory", + "cl_init", + "cl_initialize_crypto", + "cl_load", + "cl_retdbdir", + "cl_retflevel", + "cl_retver", + "cl_scandesc", + "cl_scandesc_callback", + "cl_scanfile", + "cl_scanfile_callback", + "cl_scanmap_callback", + "cl_set_clcb_msg", + "cl_strerror", + "cli_append_virus", + "cli_ctx", + "cli_dbgmsg_no_inline", + "cli_errmsg", + "cli_get_debug_flag", + "cli_getdsig", + "cli_infomsg_simple", + "cli_versig2", + "cli_warnmsg", + "lsig_increment_subsig_match", +]; + +// Generate bindings for these types (structs, prototypes, etc.): +const BINDGEN_TYPES: &[&str] = &[ + "cl_cvd", + "clcb_file_props", + "clcb_meta", + "clcb_post_scan", + "clcb_pre_scan", + "cli_ac_data", + "cli_ac_result", + "cli_matcher", + "time_t", +]; + +// Generate "newtype" enums for these C enums +const BINDGEN_ENUMS: &[&str] = &["cl_engine_field", "cl_error_t", "cl_msg"]; + +const BINDGEN_CONSTANTS: &[&str] = &[ + "CL_DB_.*", + "CL_INIT_DEFAULT", + "CL_SCAN_.*", + "ENGINE_OPTIONS_.*", + "LAYER_ATTRIBUTES_.*", +]; + +const CLAMAV_LIBRARY_NAME: &str = "clamav"; + fn generate_bindings(customize_bindings: &dyn Fn(bindgen::Builder) -> bindgen::Builder) { - let mut bindings = bindgen::Builder::default() - // The input header we would like to generate - // bindings for. - //Whitelist wanted functions - .whitelist_function("cl_cleanup_crypto") - .whitelist_function("cl_engine_compile") - .whitelist_function("cl_engine_free") - .whitelist_function("cl_engine_get_num") - .whitelist_function("cl_engine_get_str") - .whitelist_function("cl_engine_new") - .whitelist_function("cl_engine_set_num") - .whitelist_function("cl_engine_set_str") - .whitelist_function("cl_fmap_close") - .whitelist_function("cl_fmap_open_handle") - .whitelist_function("cl_fmap_open_memory") - .whitelist_function("cl_init") - .whitelist_function("cl_initialize_crypto") - .whitelist_function("cl_load") - .whitelist_function("cl_retdbdir") - .whitelist_function("cl_retflevel") - .whitelist_function("cl_retver") - .whitelist_function("cl_scandesc") - .whitelist_function("cl_scanfile") - .whitelist_function("cl_scanmap_callback") - .whitelist_function("cl_set_clcb_msg") - .whitelist_function("cl_strerror") - //Whitelist wanted types - .rustified_enum("cl_engine_field") - .rustified_enum("cl_error_t") - .rustified_enum("cl_msg") - .whitelist_type("time_t") - //Whitelist wanted constants - .whitelist_var("CL_DB_.*") - .whitelist_var("CL_INIT_DEFAULT") - .whitelist_var("CL_SCAN_.*") + let mut bindings = bindgen::Builder::default(); + for function in BINDGEN_FUNCTIONS { + bindings = bindings.allowlist_function(function); + } + + for typename in BINDGEN_TYPES { + bindings = bindings.allowlist_type(typename); + } + + for typename in BINDGEN_ENUMS { + bindings = bindings.newtype_enum(typename); + } + + for constant in BINDGEN_CONSTANTS { + bindings = bindings.allowlist_var(constant); + } + + bindings = bindings .header("wrapper.h") // Tell cargo to invalidate the built crate whenever any of the // included header files changed. @@ -74,7 +150,7 @@ fn generate_bindings(customize_bindings: &dyn Fn(bindgen::Builder) -> bindgen::B } fn cargo_common() { - println!("cargo:rustc-link-lib=dylib={}", "clamav"); + println!("cargo:rustc-link-lib=dylib={}", CLAMAV_LIBRARY_NAME); // Tell cargo to invalidate the built crate whenever the wrapper changes println!("cargo:rerun-if-changed=wrapper.h"); @@ -130,7 +206,7 @@ fn main() { .probe("libclamav") .unwrap(); - let mut include_paths = libclamav.include_paths.clone(); + let mut include_paths = libclamav.include_paths; if let Some(val) = std::env::var_os("OPENSSL_ROOT_DIR") { let mut openssl_include_dir = PathBuf::from(val); diff --git a/src/lib.rs b/src/lib.rs index 210990b870..04c18af30d 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -17,6 +17,8 @@ #![allow(non_camel_case_types, non_upper_case_globals)] +use std::ffi::CStr; + include!(concat!(env!("OUT_DIR"), "/bindings.rs")); impl Default for cl_scan_options { @@ -50,6 +52,105 @@ impl PartialEq for cl_scan_options { } } +/// We need this for Windows, MSVC will use an `i32` as underlying enum type instead of `u32` like +/// gcc and clang. +impl From for cl_error_t { + fn from(val: i32) -> cl_error_t { + unsafe { cl_error_t(std::mem::transmute(val)) } + } +} + +impl From for cl_error_t { + fn from(val: u32) -> cl_error_t { + cl_error_t(val) + } +} + +impl From for i32 { + fn from(val: cl_error_t) -> i32 { + unsafe { std::mem::transmute(val.0) } + } +} + +impl From for u32 { + fn from(val: cl_error_t) -> u32 { + val.0 + } +} + +impl std::fmt::Display for cl_error_t { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + unsafe { + let msg = CStr::from_ptr(cl_strerror(*self)); + f.write_str(msg.to_str().unwrap_or("")) + } + } +} + +/// We need this for Windows, MSVC will use an `i32` as underlying enum type instead of `u32` like +/// gcc and clang. +impl From for cl_engine_field { + fn from(val: i32) -> cl_engine_field { + unsafe { cl_engine_field(std::mem::transmute(val)) } + } +} + +impl From for cl_engine_field { + fn from(val: u32) -> cl_engine_field { + cl_engine_field(val) + } +} + +impl From for i32 { + fn from(val: cl_engine_field) -> i32 { + unsafe { std::mem::transmute(val.0) } + } +} + +impl From for u32 { + fn from(val: cl_engine_field) -> u32 { + val.0 + } +} + +impl std::fmt::Display for cl_engine_field { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + std::fmt::Display::fmt(&self.0, f) + } +} + +/// We need this for Windows, MSVC will use an `i32` as underlying enum type instead of `u32` like +/// gcc and clang. +impl From for cl_msg { + fn from(val: i32) -> cl_msg { + unsafe { cl_msg(std::mem::transmute(val)) } + } +} + +impl From for cl_msg { + fn from(val: u32) -> cl_msg { + cl_msg(val) + } +} + +impl From for i32 { + fn from(val: cl_msg) -> i32 { + unsafe { std::mem::transmute(val.0) } + } +} + +impl From for u32 { + fn from(val: cl_msg) -> u32 { + val.0 + } +} + +impl std::fmt::Display for cl_msg { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + std::fmt::Display::fmt(&self.0, f) + } +} + #[cfg(test)] mod tests { use super::cl_msg; @@ -58,8 +159,14 @@ mod tests { fn msg_levels_exist() { // Just a compilation check that the message levels are there. We don't // check their values since those are defined in the C header file. - assert!(cl_msg::CL_MSG_WARN as isize != 0); - assert!(cl_msg::CL_MSG_ERROR as isize != 0); - assert!(cl_msg::CL_MSG_INFO_VERBOSE as isize != 0); + assert!(cl_msg::CL_MSG_WARN != cl_msg(0)); + assert!(cl_msg::CL_MSG_ERROR != cl_msg(0)); + assert!(cl_msg::CL_MSG_INFO_VERBOSE != cl_msg(0)); + } + + #[test] + fn test_cl_error_t_to_string() { + let err = super::cl_error_t::CL_EMEM; + assert_eq!(err.to_string(), "Can't allocate memory".to_string()); } } From 0c2906923f20cde90c6be65489b99b2267bd31a8 Mon Sep 17 00:00:00 2001 From: Scott Hutton Date: Wed, 8 Nov 2023 09:18:25 -0800 Subject: [PATCH 17/26] clamav-sys: Update repo and authors --- Cargo.toml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index b861036c36..86912f06b8 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,12 +1,15 @@ [package] -authors = ["Jonas Zaddach "] +authors = [ + "Jonas Zaddach ", + "Scott Hutton ", +] categories = ["external-ffi-bindings"] description = "ClamAV low level bindings for Rust" edition = "2021" homepage = "https://github.com/zaddach/clamav-sys/" license = "GPL-2.0" name = "clamav-sys" -repository = "https://github.com/zaddach/clamav-sys/" +repository = "https://github.com/Cisco-Talos/clamav-sys/" version = "1.0.0" [build-dependencies] From 00fb8bc54d089804d30a1a6fa350ee7cc6e12c59 Mon Sep 17 00:00:00 2001 From: Scott Hutton Date: Tue, 14 Nov 2023 10:09:37 -0800 Subject: [PATCH 18/26] clamav-sys: Increase clippy linting strictness --- src/lib.rs | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/lib.rs b/src/lib.rs index 04c18af30d..faab3c5721 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -15,7 +15,12 @@ // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, // MA 02110-1301, USA. -#![allow(non_camel_case_types, non_upper_case_globals)] +#![warn(clippy::all, clippy::pedantic)] +#![allow( + non_camel_case_types, + non_upper_case_globals, + clippy::unreadable_literal +)] use std::ffi::CStr; From 3192bd785d84d83858144bec61550897f474c29e Mon Sep 17 00:00:00 2001 From: Scott Hutton Date: Tue, 14 Nov 2023 10:18:10 -0800 Subject: [PATCH 19/26] clamav-sys: Update copyright --- build.rs | 3 ++- src/lib.rs | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/build.rs b/build.rs index a6d1e9204d..98479cfe57 100644 --- a/build.rs +++ b/build.rs @@ -1,5 +1,6 @@ +// Copyright (C) 2020-2023 Cisco Systems, Inc. and/or its affiliates. All rights reserved. // -// Copyright (C) 2020 Jonas Zaddach. +// Authors: Jonas Zaddach, Scott Hutton // // This program is free software; you can redistribute it and/or modify // it under the terms of the GNU General Public License version 2 as diff --git a/src/lib.rs b/src/lib.rs index faab3c5721..a926b9551d 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,5 +1,6 @@ +// Copyright (C) 2020-2023 Cisco Systems, Inc. and/or its affiliates. All rights reserved. // -// Copyright (C) 2020 Jonas Zaddach. +// Authors: Jonas Zaddach, Scott Hutton // // This program is free software; you can redistribute it and/or modify // it under the terms of the GNU General Public License version 2 as From ccfb41731b42164fcd069cd87a90bca7a19f838a Mon Sep 17 00:00:00 2001 From: Scott Hutton Date: Tue, 14 Nov 2023 10:27:55 -0800 Subject: [PATCH 20/26] clamav-sys: Correct homepage URL --- Cargo.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 86912f06b8..43556ce9bf 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -6,7 +6,7 @@ authors = [ categories = ["external-ffi-bindings"] description = "ClamAV low level bindings for Rust" edition = "2021" -homepage = "https://github.com/zaddach/clamav-sys/" +homepage = "https://github.com/Cisco-Talos/clamav-sys/" license = "GPL-2.0" name = "clamav-sys" repository = "https://github.com/Cisco-Talos/clamav-sys/" From 6c8848806739d1de119e66f7eb373a408cb9b67a Mon Sep 17 00:00:00 2001 From: Scott Hutton Date: Mon, 8 Jan 2024 09:57:34 -0800 Subject: [PATCH 21/26] clamav-sys: Update authors --- Cargo.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 43556ce9bf..6beff91f14 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] authors = [ - "Jonas Zaddach ", + "Jonas Zaddach ", "Scott Hutton ", ] categories = ["external-ffi-bindings"] From 917bcc2b449a41d0038971156c025496d65f2e7f Mon Sep 17 00:00:00 2001 From: Scott Hutton Date: Tue, 9 Jan 2024 09:21:11 -0800 Subject: [PATCH 22/26] clamav-sys: Bury crate for merge into Cisco-Talos/clamav --- .gitignore => clamav-sys/.gitignore | 0 Cargo.toml => clamav-sys/Cargo.toml | 0 LICENSE => clamav-sys/LICENSE | 0 README.md => clamav-sys/README.md | 0 build.rs => clamav-sys/build.rs | 0 {src => clamav-sys/src}/lib.rs | 0 wrapper.h => clamav-sys/wrapper.h | 0 7 files changed, 0 insertions(+), 0 deletions(-) rename .gitignore => clamav-sys/.gitignore (100%) rename Cargo.toml => clamav-sys/Cargo.toml (100%) rename LICENSE => clamav-sys/LICENSE (100%) rename README.md => clamav-sys/README.md (100%) rename build.rs => clamav-sys/build.rs (100%) rename {src => clamav-sys/src}/lib.rs (100%) rename wrapper.h => clamav-sys/wrapper.h (100%) diff --git a/.gitignore b/clamav-sys/.gitignore similarity index 100% rename from .gitignore rename to clamav-sys/.gitignore diff --git a/Cargo.toml b/clamav-sys/Cargo.toml similarity index 100% rename from Cargo.toml rename to clamav-sys/Cargo.toml diff --git a/LICENSE b/clamav-sys/LICENSE similarity index 100% rename from LICENSE rename to clamav-sys/LICENSE diff --git a/README.md b/clamav-sys/README.md similarity index 100% rename from README.md rename to clamav-sys/README.md diff --git a/build.rs b/clamav-sys/build.rs similarity index 100% rename from build.rs rename to clamav-sys/build.rs diff --git a/src/lib.rs b/clamav-sys/src/lib.rs similarity index 100% rename from src/lib.rs rename to clamav-sys/src/lib.rs diff --git a/wrapper.h b/clamav-sys/wrapper.h similarity index 100% rename from wrapper.h rename to clamav-sys/wrapper.h From 8c7a3ff50ad38ab06fc6c2f451b9d46d65a1b8dc Mon Sep 17 00:00:00 2001 From: Scott Hutton Date: Tue, 9 Jan 2024 16:34:29 -0800 Subject: [PATCH 23/26] Add clamav-sys to cargo workspace --- Cargo.toml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 1d15ccd140..56cdaeac9d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,8 +1,6 @@ [workspace] -members = [ - "libclamav_rust", -] +members = ["clamav-sys", "libclamav_rust"] [profile.dev.package."*"] opt-level = 2 From 27c66b1235dc3ceb140987db1f02b7c3a6e54130 Mon Sep 17 00:00:00 2001 From: Micah Snyder Date: Tue, 19 Dec 2023 10:15:42 -0500 Subject: [PATCH 24/26] CMake+Rust: Fix offline builds w. vendored git repos Some builds using the tarball with the vendored Rust dependencies are failing. The onenote-rs dependency is presently tied to a git branch from github rather than using a release from crates.io. This is the differing factor though I'm unsure why it is causing the build to try to update the repo rather than just building the vendored source. This commit adds a `--offline` parameter to the build options if the vendored source is detected, in an attempt to force Cargo to use what it has and stay offline. --- cmake/FindRust.cmake | 44 ++++++++++++++++++++++++-------------------- 1 file changed, 24 insertions(+), 20 deletions(-) diff --git a/cmake/FindRust.cmake b/cmake/FindRust.cmake index 6e6b5fc264..9ce0850a18 100644 --- a/cmake/FindRust.cmake +++ b/cmake/FindRust.cmake @@ -184,28 +184,28 @@ function(cargo_vendor) set(oneValueArgs TARGET SOURCE_DIRECTORY BINARY_DIRECTORY) cmake_parse_arguments(ARGS "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) - if(NOT EXISTS ${ARGS_SOURCE_DIRECTORY}/.cargo/config.toml) - # Vendor the dependencies and create .cargo/config.toml - # Vendored dependencies will be used during the build. - # This will allow us to package vendored dependencies in source tarballs - # for online builds when we run `cpack --config CPackSourceConfig.cmake` - message(STATUS "Running `cargo vendor` to collect dependencies for ${ARGS_TARGET}. This may take a while if the local crates.io index needs to be updated ...") - make_directory(${ARGS_SOURCE_DIRECTORY}/.cargo) - execute_process( - COMMAND ${CMAKE_COMMAND} -E env "CARGO_TARGET_DIR=${ARGS_BINARY_DIRECTORY}" ${cargo_EXECUTABLE} vendor ".cargo/vendor" - WORKING_DIRECTORY "${ARGS_SOURCE_DIRECTORY}" - OUTPUT_VARIABLE CARGO_VENDOR_OUTPUT - ERROR_VARIABLE CARGO_VENDOR_ERROR - RESULT_VARIABLE CARGO_VENDOR_RESULT - ) + # Vendor the dependencies and create .cargo/config.toml + # Vendored dependencies will be used during the build. + # This will allow us to package vendored dependencies in source tarballs + # for online builds when we run `cpack --config CPackSourceConfig.cmake` + message(STATUS "Running `cargo vendor` to collect dependencies for ${ARGS_TARGET}. This may take a while if the local crates.io index needs to be updated ...") + make_directory(${CMAKE_SOURCE_DIR}/.cargo) + execute_process( + COMMAND ${CMAKE_COMMAND} -E env "CARGO_TARGET_DIR=${ARGS_BINARY_DIRECTORY}" ${cargo_EXECUTABLE} vendor "${CMAKE_SOURCE_DIR}/.cargo/vendor" + WORKING_DIRECTORY "${ARGS_SOURCE_DIRECTORY}" + OUTPUT_VARIABLE CARGO_VENDOR_OUTPUT + ERROR_VARIABLE CARGO_VENDOR_ERROR + RESULT_VARIABLE CARGO_VENDOR_RESULT + ) - if(NOT ${CARGO_VENDOR_RESULT} EQUAL 0) - message(FATAL_ERROR "Failed!\n${CARGO_VENDOR_ERROR}") - else() - message("Success!") - endif() + if(NOT ${CARGO_VENDOR_RESULT} EQUAL 0) + message(FATAL_ERROR "Failed!\n${CARGO_VENDOR_ERROR}") + else() + message("Success!") + endif() - write_file(${ARGS_SOURCE_DIRECTORY}/.cargo/config.toml " + if(NOT EXISTS ${CMAKE_SOURCE_DIR}/.cargo/config.toml) + write_file(${CMAKE_SOURCE_DIR}/.cargo/config.toml " [source.crates-io] replace-with = \"vendored-sources\" @@ -460,6 +460,10 @@ endif() set(CARGO_ARGS "build") +if(EXISTS "${CMAKE_SOURCE_DIR}/.cargo/vendor") + list(APPEND CARGO_ARGS "--offline") +endif() + if(NOT "${RUST_COMPILER_TARGET}" MATCHES "^universal-apple-darwin$") # Don't specify the target for macOS universal builds, we'll do that manually for each build. list(APPEND CARGO_ARGS "--target" ${RUST_COMPILER_TARGET}) From 6dc81cb3bc05e666f90a8799c57e9d14b2e29f02 Mon Sep 17 00:00:00 2001 From: Micah Snyder Date: Tue, 19 Dec 2023 18:52:44 -0500 Subject: [PATCH 25/26] Cargo+Rust: add git repo source as vendored source --- cmake/FindRust.cmake | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/cmake/FindRust.cmake b/cmake/FindRust.cmake index 9ce0850a18..f2274a0084 100644 --- a/cmake/FindRust.cmake +++ b/cmake/FindRust.cmake @@ -209,6 +209,11 @@ function(cargo_vendor) [source.crates-io] replace-with = \"vendored-sources\" +[source.\"git+https://github.com/Cisco-Talos/onenote.rs.git?branch=CLAM-2329-new-from-slice\"] +git = \"hhttps://github.com/Cisco-Talos/onenote.rs.git\" +branch = \"CLAM-2329-new-from-slice\" +replace-with = \"vendored-sources\" + [source.vendored-sources] directory = \".cargo/vendor\" " From 1c8003bb5d31bbab73f3ae315c73c0c8e92fd6a8 Mon Sep 17 00:00:00 2001 From: Scott Hutton Date: Thu, 18 Jan 2024 09:59:31 -0800 Subject: [PATCH 26/26] Refactor and extend FindRust.cmake Export additional build context to Rust-based builds, and eliminate some of the duplicated logic when bulding a macOS univeral binary. --- cmake/FindRust.cmake | 86 ++++++++++++++++++++++++++++++-------------- 1 file changed, 60 insertions(+), 26 deletions(-) diff --git a/cmake/FindRust.cmake b/cmake/FindRust.cmake index f2274a0084..7b9181fdca 100644 --- a/cmake/FindRust.cmake +++ b/cmake/FindRust.cmake @@ -142,6 +142,10 @@ if(NOT DEFINED CARGO_HOME) endif() endif() +# +# Environment for most invocations of `cargo` +# + include(FindPackageHandleStandardArgs) function(find_rust_program RUST_PROGRAM) @@ -190,6 +194,7 @@ function(cargo_vendor) # for online builds when we run `cpack --config CPackSourceConfig.cmake` message(STATUS "Running `cargo vendor` to collect dependencies for ${ARGS_TARGET}. This may take a while if the local crates.io index needs to be updated ...") make_directory(${CMAKE_SOURCE_DIR}/.cargo) + GetCargoLocalDirEnv(_cargo_local_dir_env) execute_process( COMMAND ${CMAKE_COMMAND} -E env "CARGO_TARGET_DIR=${ARGS_BINARY_DIRECTORY}" ${cargo_EXECUTABLE} vendor "${CMAKE_SOURCE_DIR}/.cargo/vendor" WORKING_DIRECTORY "${ARGS_SOURCE_DIRECTORY}" @@ -221,6 +226,24 @@ directory = \".cargo/vendor\" endif() endfunction() +# Export the project name (including upstream project) and maintainer mode +# status for use by build scripts +function(GetCargoExtraEnv result) + set(_result "PROJECT_NAME=${PROJECT_NAME}") + list(APPEND _result "CMAKE_PROJECT_NAME=${CMAKE_PROJECT_NAME}") + list(APPEND _result "MAINTAINER_MODE=${MAINTAINER_MODE}") + # Propagate any additional Rust compiler flags + list(APPEND _result "RUSTFLAGS=${RUSTFLAGS}") + set("${result}" "${_result}" PARENT_SCOPE) +endfunction() + +function(GetCargoLocalDirEnv result) + # Specify the destination directory for build products + set(_env "CARGO_TARGET_DIR=${ARGS_BINARY_DIRECTORY}") + list(APPEND _env "CARGO_INCLUDE_DIRECTORIES=\"${ARGS_INCLUDE_DIRECTORIES}\"") + set(${result} "${_env}" PARENT_SCOPE) +endfunction() + function(add_rust_executable) set(options) set(oneValueArgs TARGET SOURCE_DIRECTORY BINARY_DIRECTORY) @@ -238,10 +261,14 @@ function(add_rust_executable) list(APPEND MY_CARGO_ARGS "--target-dir" ${ARGS_BINARY_DIRECTORY}) list(JOIN MY_CARGO_ARGS " " MY_CARGO_ARGS_STRING) + GetCargoExtraEnv(_cargo_extra_env) + GetCargoLocalDirEnv(_cargo_local_dir_env) + # Build the executable. add_custom_command( OUTPUT "${OUTPUT}" - COMMAND ${CMAKE_COMMAND} -E env "CARGO_TARGET_DIR=${ARGS_BINARY_DIRECTORY}" "CARGO_INCLUDE_DIRECTORIES=\"${ARGS_INCLUDE_DIRECTORIES}\"" ${cargo_EXECUTABLE} ${MY_CARGO_ARGS} + COMMAND ${CMAKE_COMMAND} -E env "${_cargo_extra_env}" "${_cargo_local_dir_env}" ${cargo_EXECUTABLE} ${MY_CARGO_ARGS} + COMMAND_EXPAND_LISTS WORKING_DIRECTORY "${ARGS_SOURCE_DIRECTORY}" DEPENDS ${EXE_SOURCES} COMMENT "Building ${ARGS_TARGET} in ${ARGS_BINARY_DIRECTORY} with:\n\t ${cargo_EXECUTABLE} ${MY_CARGO_ARGS_STRING}") @@ -288,39 +315,42 @@ function(add_rust_library) list(APPEND MY_CARGO_ARGS "--target-dir" ${ARGS_BINARY_DIRECTORY}) list(JOIN MY_CARGO_ARGS " " MY_CARGO_ARGS_STRING) - # Build the library and generate the c-binding - if("${CMAKE_OSX_ARCHITECTURES}" MATCHES "^(arm64;x86_64|x86_64;arm64)$") + GetCargoExtraEnv(_cargo_extra_env) + GetCargoLocalDirEnv(_cargo_local_dir_env) + + if(RUST_COMPILER_TARGET STREQUAL "universal-apple-darwin") + foreach(arch IN LISTS CMAKE_OSX_ARCHITECTURES) + message("Making custom command for OSX arch ${arch}") + if(arch STREQUAL "arm64") + # Convert to rustc's designation + set(arch "aarch64") + endif() + set(this_output "${ARGS_BINARY_DIRECTORY}/${arch}-apple-darwin/${CARGO_BUILD_TYPE}/lib${ARGS_TARGET}.a") + list(APPEND lipo_inputs "${this_output}") + add_custom_command( + OUTPUT "${this_output}" + COMMAND ${CMAKE_COMMAND} -E env "CARGO_CMD=build" "${_cargo_extra_env}" "${_cargo_local_dir_env}" ${cargo_EXECUTABLE} ${MY_CARGO_ARGS} --target=${arch}-apple-darwin + COMMAND_EXPAND_LISTS + WORKING_DIRECTORY "${ARGS_SOURCE_DIRECTORY}" + DEPENDS ${LIB_SOURCES} + COMMENT "Building ${ARGS_TARGET} for ${arch} in ${ARGS_BINARY_DIRECTORY} with: ${cargo_EXECUTABLE} ${MY_CARGO_ARGS_STRING}") + endforeach() + # `lipo` will provide the Universal binary add_custom_command( OUTPUT "${OUTPUT}" - COMMAND ${CMAKE_COMMAND} -E env "CARGO_CMD=build" "CARGO_TARGET_DIR=${ARGS_BINARY_DIRECTORY}" "MAINTAINER_MODE=${MAINTAINER_MODE}" "CARGO_INCLUDE_DIRECTORIES=\"${ARGS_INCLUDE_DIRECTORIES}\"" "RUSTFLAGS=${RUSTFLAGS}" ${cargo_EXECUTABLE} ${MY_CARGO_ARGS} --target=x86_64-apple-darwin - COMMAND ${CMAKE_COMMAND} -E env "CARGO_CMD=build" "CARGO_TARGET_DIR=${ARGS_BINARY_DIRECTORY}" "MAINTAINER_MODE=${MAINTAINER_MODE}" "CARGO_INCLUDE_DIRECTORIES=\"${ARGS_INCLUDE_DIRECTORIES}\"" "RUSTFLAGS=${RUSTFLAGS}" ${cargo_EXECUTABLE} ${MY_CARGO_ARGS} --target=aarch64-apple-darwin COMMAND ${CMAKE_COMMAND} -E make_directory "${ARGS_BINARY_DIRECTORY}/${RUST_COMPILER_TARGET}/${CARGO_BUILD_TYPE}" COMMAND lipo -create ${ARGS_BINARY_DIRECTORY}/x86_64-apple-darwin/${CARGO_BUILD_TYPE}/lib${ARGS_TARGET}.a ${ARGS_BINARY_DIRECTORY}/aarch64-apple-darwin/${CARGO_BUILD_TYPE}/lib${ARGS_TARGET}.a -output "${OUTPUT}" WORKING_DIRECTORY "${ARGS_SOURCE_DIRECTORY}" - DEPENDS ${LIB_SOURCES} - COMMENT "Building ${ARGS_TARGET} in ${ARGS_BINARY_DIRECTORY} with: ${cargo_EXECUTABLE} ${MY_CARGO_ARGS_STRING}") - elseif("${CMAKE_OSX_ARCHITECTURES}" MATCHES "^(arm64)$") - add_custom_command( - OUTPUT "${OUTPUT}" - COMMAND ${CMAKE_COMMAND} -E env "CARGO_CMD=build" "CARGO_TARGET_DIR=${ARGS_BINARY_DIRECTORY}" "MAINTAINER_MODE=${MAINTAINER_MODE}" "CARGO_INCLUDE_DIRECTORIES=\"${ARGS_INCLUDE_DIRECTORIES}\"" "RUSTFLAGS=${RUSTFLAGS}" ${cargo_EXECUTABLE} ${MY_CARGO_ARGS} --target=aarch64-apple-darwin - WORKING_DIRECTORY "${ARGS_SOURCE_DIRECTORY}" - DEPENDS ${LIB_SOURCES} - COMMENT "Building ${ARGS_TARGET} in ${ARGS_BINARY_DIRECTORY} with: ${cargo_EXECUTABLE} ${MY_CARGO_ARGS_STRING}") - elseif("${CMAKE_OSX_ARCHITECTURES}" MATCHES "^(x86_64)$") - add_custom_command( - OUTPUT "${OUTPUT}" - COMMAND ${CMAKE_COMMAND} -E env "CARGO_CMD=build" "CARGO_TARGET_DIR=${ARGS_BINARY_DIRECTORY}" "MAINTAINER_MODE=${MAINTAINER_MODE}" "CARGO_INCLUDE_DIRECTORIES=\"${ARGS_INCLUDE_DIRECTORIES}\"" "RUSTFLAGS=${RUSTFLAGS}" ${cargo_EXECUTABLE} ${MY_CARGO_ARGS} --target=x86_64-apple-darwin - COMMAND ${CMAKE_COMMAND} -E make_directory "${ARGS_BINARY_DIRECTORY}/${RUST_COMPILER_TARGET}/${CARGO_BUILD_TYPE}" - WORKING_DIRECTORY "${ARGS_SOURCE_DIRECTORY}" - DEPENDS ${LIB_SOURCES} - COMMENT "Building ${ARGS_TARGET} in ${ARGS_BINARY_DIRECTORY} with: ${cargo_EXECUTABLE} ${MY_CARGO_ARGS_STRING}") + DEPENDS ${lipo_inputs} + COMMENT "Composing universal binary in ${ARGS_BINARY_DIRECTORY}") else() add_custom_command( OUTPUT "${OUTPUT}" - COMMAND ${CMAKE_COMMAND} -E env "CARGO_CMD=build" "CARGO_TARGET_DIR=${ARGS_BINARY_DIRECTORY}" "MAINTAINER_MODE=${MAINTAINER_MODE}" "CARGO_INCLUDE_DIRECTORIES=\"${ARGS_INCLUDE_DIRECTORIES}\"" "RUSTFLAGS=${RUSTFLAGS}" ${cargo_EXECUTABLE} ${MY_CARGO_ARGS} + COMMAND ${CMAKE_COMMAND} -E env "CARGO_CMD=build" "${_cargo_extra_env}" "${_cargo_local_dir_env}" ${cargo_EXECUTABLE} ${MY_CARGO_ARGS} + COMMAND_EXPAND_LISTS WORKING_DIRECTORY "${ARGS_SOURCE_DIRECTORY}" DEPENDS ${LIB_SOURCES} - COMMENT "Building ${ARGS_TARGET} in ${ARGS_BINARY_DIRECTORY} with: ${cargo_EXECUTABLE} ${MY_CARGO_ARGS_STRING}") + COMMENT "Building ${ARGS_TARGET} for ${arch} in ${ARGS_BINARY_DIRECTORY} with: ${cargo_EXECUTABLE} ${MY_CARGO_ARGS_STRING}") endif() # Create a target from the build output @@ -367,7 +397,7 @@ function(add_rust_test) list(JOIN MY_CARGO_ARGS " " MY_CARGO_ARGS_STRING) if(ARGS_PRECOMPILE_TESTS) - list(APPEND ARGS_PRECOMPILE_ENVIRONMENT "CARGO_CMD=test" "CARGO_TARGET_DIR=${ARGS_BINARY_DIRECTORY}") + list(APPEND ARGS_PRECOMPILE_ENVIRONMENT "CARGO_CMD=test" "PROJECT_NAME=${PROJECT_NAME}" "CMAKE_PROJECT_NAME=${CMAKE_PROJECT_NAME}" "CARGO_TARGET_DIR=${ARGS_BINARY_DIRECTORY}") add_custom_target(${ARGS_NAME}_tests ALL COMMAND ${CMAKE_COMMAND} -E env ${ARGS_PRECOMPILE_ENVIRONMENT} ${cargo_EXECUTABLE} ${MY_CARGO_ARGS} --color always --no-run DEPENDS ${ARGS_PRECOMPILE_DEPENDS} @@ -375,9 +405,13 @@ function(add_rust_test) ) endif() + GetCargoExtraEnv(_cargo_extra_env) + GetCargoLocalDirEnv(_cargo_local_dir_env) + add_test( NAME ${ARGS_NAME} - COMMAND ${CMAKE_COMMAND} -E env "CARGO_CMD=test" "CARGO_TARGET_DIR=${ARGS_BINARY_DIRECTORY}" "RUSTFLAGS=${RUSTFLAGS}" ${cargo_EXECUTABLE} ${MY_CARGO_ARGS} --color always + COMMAND ${CMAKE_COMMAND} -E env "CARGO_CMD=test" "${_cargo_extra_env}" "${_cargo_local_dir_env}" "RUSTFLAGS=${RUSTFLAGS}" ${cargo_EXECUTABLE} ${MY_CARGO_ARGS} --color always + COMMAND_EXPAND_LISTS WORKING_DIRECTORY ${ARGS_SOURCE_DIRECTORY} ) endfunction()