rust plugins: provide bindings to register eve filetype plugins - v1 #12446
+136
−4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
With the recent refactor, the log level as seen by plugins was not being updated when being set through the C interface, so just set it directly upon plugin initialization.
This allow for an EVE file type plugin written in Rust to register itself without needing to provide its own Rust bindings.
jasonish
commented
Jan 21, 2025
Comment on lines
+146
to
+161
| // Get a child node of this node by name. | ||
| // | ||
| // Wrapper around ConfNodeLookupChild. | ||
| // | ||
| // Returns None if the child is not found. | ||
| pub fn get_child(&self, name: &str) -> Option<ConfNode> { | ||
| unsafe { | ||
| let name = CString::new(name).unwrap(); | ||
| let child = ConfNodeLookupChild(self.conf, name.as_ptr()); | ||
| if child.is_null() { | ||
| None | ||
| } else { | ||
| Some(ConfNode { conf: child }) | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Not used by our Rust, but still an existing conf function that was never exposed to Rust. But useful to have.
jasonish
commented
Jan 21, 2025
Comment on lines
+50
to
+59
| #[repr(C)] | ||
| pub struct EveFileType { | ||
| name: *const c_char, | ||
| open: EveFileInitFn, | ||
| thread_init: EveFileThreadInitFn, | ||
| write: EveFileWriteFn, | ||
| thread_deinit: EveFileThreadDeinitFn, | ||
| close: EveFileDeinitFn, | ||
| pad: [usize; 2], | ||
| } |
There was a problem hiding this comment.
Its kind of painful to have to duplicate this, yet I don't want to cbindgen it from Rust to C, because this is functionality owned by C. The other alternative is bindgen to generate Rust from C, but has some extra developer overhead like requiring clang.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #12446 +/- ##
==========================================
- Coverage 80.63% 80.62% -0.01%
==========================================
Files 920 921 +1
Lines 258704 258740 +36
==========================================
+ Hits 208595 208606 +11
- Misses 50109 50134 +25
Flags with carried forward coverage won't be shown. Click here to find out more. |
|
Information: QA ran without warnings. Pipeline 24312 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
First, fix some breaking changes done in the visibility cleanups with respect to Rust plugins and using our log macros.
But primarily, add Rust bindings to our C EVE filetype registration. For 7.0 my Redis example plugin provided its own bindings, (see https://github.com/jasonish/suricata-redis-output/blob/main/src/ffi.rs), but ideally those should be provided by Suricata.
This patch brings enough bindings over to register EVE filetypes such as a Redis output without having to provide any custom C bindings itself.