feat: do not enable cuckoo feature by default

Author: vthib

.github/workflows/ci.yml

@@ -77,7 +77,7 @@ jobs:
         run: |
           cd boreal-py
           uv sync --dev
-          uv run pytest
+          uv run --config-setting "build-args=--features=cuckoo" pytest
 
     strategy:
       fail-fast: false
@@ -313,7 +313,7 @@ jobs:
 
           # And run the python bindings tests
           cd boreal-py
-          uv run --config-setting 'build-args=--profile=dev' pytest
+          uv run --config-setting 'build-args=--profile=dev --features=cuckoo' pytest
           cd ..
 
           # Finally, generate the report

boreal-py/Cargo.toml

@@ -16,7 +16,7 @@ name = "boreal"
 crate-type = ["cdylib"]
 
 [features]
-default = ["cuckoo"]
+default = []
 
 cuckoo = ["boreal/cuckoo"]
 

boreal-py/src/lib.rs

@@ -5,7 +5,7 @@ use std::ffi::CString;
 
 use pyo3::exceptions::{PyException, PyTypeError};
 use pyo3::prelude::*;
-use pyo3::types::PyDict;
+use pyo3::types::{PyDict, PyString};
 use pyo3::{create_exception, ffi, intern};
 
 use ::boreal::compiler;
@@ -25,6 +25,7 @@ create_exception!(boreal, AddRuleError, PyException, "error when adding rules");
 #[pymodule]
 fn boreal(m: &Bound<'_, PyModule>) -> PyResult<()> {
     m.add_function(wrap_pyfunction!(compile, m)?)?;
+    m.add_function(wrap_pyfunction!(available_modules, m)?)?;
 
     m.add("AddRuleError", m.py().get_type::<AddRuleError>())?;
     m.add("ScanError", m.py().get_type::<scanner::ScanError>())?;
@@ -56,17 +57,7 @@ fn compile(
     includes: bool,
     error_on_warning: bool,
 ) -> PyResult<scanner::Scanner> {
-    let mut compiler = compiler::CompilerBuilder::new()
-        .add_module(::boreal::module::Console::with_callback(|log| {
-            // XXX: when targetting python 3.12 or above, this could be simplified
-            // by using the "%.*s" format, avoiding the CString conversion.
-            if let Ok(cstr) = CString::new(log) {
-                // Safety: see <https://docs.python.org/3/c-api/unicode.html#c.PyUnicode_FromFormat>
-                // for the format. A '%s" expects a c-string pointer, which has just been built.
-                unsafe { ffi::PySys_FormatStdout(c"%s\n".as_ptr(), cstr.as_ptr()) }
-            }
-        }))
-        .build();
+    let mut compiler = build_compiler();
 
     compiler.set_params(
         compiler::CompilerParams::default()
@@ -159,6 +150,28 @@ fn compile(
     Ok(scanner::Scanner::new(compiler.into_scanner(), warnings))
 }
 
+#[pyfunction]
+fn available_modules(py: Python<'_>) -> Vec<Bound<'_, PyString>> {
+    build_compiler()
+        .available_modules()
+        .map(|s| PyString::new(py, s))
+        .collect()
+}
+
+fn build_compiler() -> compiler::Compiler {
+    compiler::CompilerBuilder::new()
+        .add_module(::boreal::module::Console::with_callback(|log| {
+            // XXX: when targetting python 3.12 or above, this could be simplified
+            // by using the "%.*s" format, avoiding the CString conversion.
+            if let Ok(cstr) = CString::new(log) {
+                // Safety: see <https://docs.python.org/3/c-api/unicode.html#c.PyUnicode_FromFormat>
+                // for the format. A '%s" expects a c-string pointer, which has just been built.
+                unsafe { ffi::PySys_FormatStdout(c"%s\n".as_ptr(), cstr.as_ptr()) }
+            }
+        }))
+        .build()
+}
+
 fn convert_compiler_error(err: &compiler::AddRuleError, input_name: &str, input: &str) -> String {
     err.to_short_description(input_name, input)
 }

boreal-py/tests/test_scanner.py

@@ -249,6 +249,10 @@ def test_match_console_log(module, is_yara, capsys):
 
 # TODO: find a way to compile yara python with cuckoo?
 def test_match_modules_data():
+    # Test only works if the cuckoo module is present
+    if 'cuckoo' not in boreal.available_modules():
+        return
+
     rules = boreal.compile(source="""
 import "cuckoo"