detect/transform: from_base64 transform #11350
Closed
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
Refactor utility functions/definitions from the byte_math module into the parser module. This includes parse_var and ResultValue Issue: 6487
Issue: 6487 Implement from_base64 option parsing in Rust. The Rust module also contains unit tests.
Issue: 6487
Implement the from_base64 transform:
[bytes value] [offset value] [mode strict|rfc4648|rfc2045]
The value for bytes and offset may be a byte_ variable or an
unsigned integer.
Issue: 6487 Document the new transform and indicate that it's the preferred way to perform base64 decoding (preferred over base64_decode)
Issue: 6487 To avoid ambiguity, a single definition for base 64 decoding modes will be used. The Rust base64 transform contains the definitions for the existing mode types: Strict, RFC2045, RFC4648
jlucovsky
requested review from
jasonish,
jufajardini and
victorjulien
as code owners
inashivb
approved these changes
Jun 21, 2024
| #[repr(u8)] | ||
| #[derive(Copy, Clone, Debug, PartialEq, Eq)] | ||
| pub enum DetectBase64Mode { | ||
| Base64ModeRelax = 0, |
There was a problem hiding this comment.
nit: Relax mode does not seem to have been implemented any longer and doesn't do anything. Do you think we should remove it?
There was a problem hiding this comment.
Good observation. I'll include that in a followup pr (post release).
| * \param det_ctx detection engine ctx | ||
| * \param s signature | ||
| * \param opts_str transform options, if any | ||
| * \retval 0 No decode |
| const uint32_t input_len = buffer->inspect_len; | ||
| /* | ||
| * The output buffer is larger than needed. On average, | ||
| * a base64 encoded string is 75% of the encoded |
There was a problem hiding this comment.
Good point ... after the release occurs, I'll update this.
victorjulien
approved these changes
Jun 21, 2024
|
Information: QA ran without warnings. Pipeline 21167 |
Merged
|
Merged in #11353, thanks! |
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.
Continuation of #11346
This PR provides the
from_base64transform used to match on content decoded with base64 using the mode (default rfc4648).Link to redmine ticket: 6487
Describe changes:
from_base64Updates:
Provide values to any of the below to override the defaults.
To use a pull request use a branch name like
pr/NwhereNis thepull request number.
Alternatively,
SV_BRANCHmay also be a link to anOISF/suricata-verify pull-request.
SV_BRANCH=OISF/suricata-verify#1670